com.google.api.services.cloudresourcemanager.model

Class OrgPolicy

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.cloudresourcemanager.model.OrgPolicy

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class OrgPolicy
extends com.google.api.client.json.GenericJson

Defines a Cloud Organization `Policy` which is used to specify `Constraints` for configurations of Cloud Platform resources.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Resource Manager API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
OrgPolicy()

Method Summary

Modifier and Type	Method and Description
OrgPolicy	clone()
byte[]	decodeEtag() An opaque tag indicating the current version of the `Policy`, used for concurrency control.
OrgPolicy	encodeEtag(byte[] etag) An opaque tag indicating the current version of the `Policy`, used for concurrency control.
BooleanPolicy	getBooleanPolicy() For boolean `Constraints`, whether to enforce the `Constraint` or not.
String	getConstraint() The name of the `Constraint` the `Policy` is configuring, for example, `constraints/serviceuser.services`.
String	getEtag() An opaque tag indicating the current version of the `Policy`, used for concurrency control.
ListPolicy	getListPolicy() List of values either allowed or disallowed.
RestoreDefault	getRestoreDefault() Restores the default behavior of the constraint; independent of `Constraint` type.
String	getUpdateTime() The time stamp the `Policy` was previously updated.
Integer	getVersion() Version of the `Policy`.
OrgPolicy	set(String fieldName, Object value)
OrgPolicy	setBooleanPolicy(BooleanPolicy booleanPolicy) For boolean `Constraints`, whether to enforce the `Constraint` or not.
OrgPolicy	setConstraint(String constraint) The name of the `Constraint` the `Policy` is configuring, for example, `constraints/serviceuser.services`.
OrgPolicy	setEtag(String etag) An opaque tag indicating the current version of the `Policy`, used for concurrency control.
OrgPolicy	setListPolicy(ListPolicy listPolicy) List of values either allowed or disallowed.
OrgPolicy	setRestoreDefault(RestoreDefault restoreDefault) Restores the default behavior of the constraint; independent of `Constraint` type.
OrgPolicy	setUpdateTime(String updateTime) The time stamp the `Policy` was previously updated.
OrgPolicy	setVersion(Integer version) Version of the `Policy`.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

OrgPolicy

public OrgPolicy()

Method Detail

getBooleanPolicy

public BooleanPolicy getBooleanPolicy()

For boolean `Constraints`, whether to enforce the `Constraint` or not.

Returns:

value or null for none

setBooleanPolicy

public OrgPolicy setBooleanPolicy(BooleanPolicy booleanPolicy)

For boolean `Constraints`, whether to enforce the `Constraint` or not.

Parameters:

booleanPolicy - booleanPolicy or null for none

getConstraint

public String getConstraint()

The name of the `Constraint` the `Policy` is configuring, for example, `constraints/serviceuser.services`. A [list of available constraints](/resource-manager/docs /organization-policy/org-policy-constraints) is available. Immutable after creation.

Returns:

value or null for none

setConstraint

public OrgPolicy setConstraint(String constraint)

The name of the `Constraint` the `Policy` is configuring, for example, `constraints/serviceuser.services`. A [list of available constraints](/resource-manager/docs /organization-policy/org-policy-constraints) is available. Immutable after creation.

Parameters:

constraint - constraint or null for none

getEtag

public String getEtag()

An opaque tag indicating the current version of the `Policy`, used for concurrency control. When the `Policy` is returned from either a `GetPolicy` or a `ListOrgPolicy` request, this `etag` indicates the version of the current `Policy` to use when executing a read-modify-write loop. When the `Policy` is returned from a `GetEffectivePolicy` request, the `etag` will be unset. When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value that was returned from a `GetOrgPolicy` request as part of a read-modify-write loop for concurrency control. Not setting the `etag`in a `SetOrgPolicy` request will result in an unconditional write of the `Policy`.

Returns:

value or null for none

See Also:

decodeEtag()

decodeEtag

public byte[] decodeEtag()

An opaque tag indicating the current version of the `Policy`, used for concurrency control. When the `Policy` is returned from either a `GetPolicy` or a `ListOrgPolicy` request, this `etag` indicates the version of the current `Policy` to use when executing a read-modify-write loop. When the `Policy` is returned from a `GetEffectivePolicy` request, the `etag` will be unset. When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value that was returned from a `GetOrgPolicy` request as part of a read-modify-write loop for concurrency control. Not setting the `etag`in a `SetOrgPolicy` request will result in an unconditional write of the `Policy`.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getEtag()

setEtag

public OrgPolicy setEtag(String etag)

An opaque tag indicating the current version of the `Policy`, used for concurrency control. When the `Policy` is returned from either a `GetPolicy` or a `ListOrgPolicy` request, this `etag` indicates the version of the current `Policy` to use when executing a read-modify-write loop. When the `Policy` is returned from a `GetEffectivePolicy` request, the `etag` will be unset. When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value that was returned from a `GetOrgPolicy` request as part of a read-modify-write loop for concurrency control. Not setting the `etag`in a `SetOrgPolicy` request will result in an unconditional write of the `Policy`.

Parameters:

etag - etag or null for none

See Also:

#encodeEtag()

encodeEtag

public OrgPolicy encodeEtag(byte[] etag)

An opaque tag indicating the current version of the `Policy`, used for concurrency control. When the `Policy` is returned from either a `GetPolicy` or a `ListOrgPolicy` request, this `etag` indicates the version of the current `Policy` to use when executing a read-modify-write loop. When the `Policy` is returned from a `GetEffectivePolicy` request, the `etag` will be unset. When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value that was returned from a `GetOrgPolicy` request as part of a read-modify-write loop for concurrency control. Not setting the `etag`in a `SetOrgPolicy` request will result in an unconditional write of the `Policy`.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getListPolicy

public ListPolicy getListPolicy()

List of values either allowed or disallowed.

Returns:

value or null for none

setListPolicy

public OrgPolicy setListPolicy(ListPolicy listPolicy)

List of values either allowed or disallowed.

Parameters:

listPolicy - listPolicy or null for none

getRestoreDefault

public RestoreDefault getRestoreDefault()

Restores the default behavior of the constraint; independent of `Constraint` type.

Returns:

value or null for none

setRestoreDefault

public OrgPolicy setRestoreDefault(RestoreDefault restoreDefault)

Restores the default behavior of the constraint; independent of `Constraint` type.

Parameters:

restoreDefault - restoreDefault or null for none

getUpdateTime

public String getUpdateTime()

The time stamp the `Policy` was previously updated. This is set by the server, not specified by the caller, and represents the last time a call to `SetOrgPolicy` was made for that `Policy`. Any value set by the client will be ignored.

Returns:

value or null for none

setUpdateTime

public OrgPolicy setUpdateTime(String updateTime)

The time stamp the `Policy` was previously updated. This is set by the server, not specified by the caller, and represents the last time a call to `SetOrgPolicy` was made for that `Policy`. Any value set by the client will be ignored.

Parameters:

updateTime - updateTime or null for none

getVersion

public Integer getVersion()

Version of the `Policy`. Default version is 0;

Returns:

value or null for none

setVersion

public OrgPolicy setVersion(Integer version)

Version of the `Policy`. Default version is 0;

Parameters:

version - version or null for none

set

public OrgPolicy set(String fieldName,
                     Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public OrgPolicy clone()

Overrides:

clone in class com.google.api.client.json.GenericJson