com.google.api.services.cloudresourcemanager.model

Class ListPolicy

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.cloudresourcemanager.model.ListPolicy

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

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

Used in `policy_type` to specify how `list_policy` behaves at this resource. A `ListPolicy` can define specific values that are allowed or denied by setting either the `allowed_values` or `denied_values` fields. It can also be used to allow or deny all values, by setting the `all_values` field. If `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values` or `denied_values` must be set (attempting to set both or neither will result in a failed request). If `all_values` is set to either `ALLOW` or `DENY`, `allowed_values` and `denied_values` must be unset.

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 Google 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

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

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ListPolicy()

Method Summary

Methods

Modifier and Type	Method and Description
ListPolicy	clone()
java.util.List<java.lang.String>	getAllowedValues() List of values allowed at this resource.
java.lang.String	getAllValues() The policy all_values state.
java.util.List<java.lang.String>	getDeniedValues() List of values denied at this resource.
java.lang.Boolean	getInheritFromParent() Determines the inheritance behavior for this `Policy`.
java.lang.String	getSuggestedValue() Optional.
ListPolicy	set(java.lang.String fieldName, java.lang.Object value)
ListPolicy	setAllowedValues(java.util.List<java.lang.String> allowedValues) List of values allowed at this resource.
ListPolicy	setAllValues(java.lang.String allValues) The policy all_values state.
ListPolicy	setDeniedValues(java.util.List<java.lang.String> deniedValues) List of values denied at this resource.
ListPolicy	setInheritFromParent(java.lang.Boolean inheritFromParent) Determines the inheritance behavior for this `Policy`.
ListPolicy	setSuggestedValue(java.lang.String suggestedValue) Optional.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ListPolicy

public ListPolicy()

Method Detail

getAllValues

public java.lang.String getAllValues()

The policy all_values state.

Returns:

value or null for none

setAllValues

public ListPolicy setAllValues(java.lang.String allValues)

The policy all_values state.

Parameters:

allValues - allValues or null for none

getAllowedValues

public java.util.List<java.lang.String> getAllowedValues()

List of values allowed at this resource. Can only be set if no values are set for `denied_values` and `all_values` is set to `ALL_VALUES_UNSPECIFIED`.

Returns:

value or null for none

setAllowedValues

public ListPolicy setAllowedValues(java.util.List<java.lang.String> allowedValues)

List of values allowed at this resource. Can only be set if no values are set for `denied_values` and `all_values` is set to `ALL_VALUES_UNSPECIFIED`.

Parameters:

allowedValues - allowedValues or null for none

getDeniedValues

public java.util.List<java.lang.String> getDeniedValues()

List of values denied at this resource. Can only be set if no values are set for `allowed_values` and `all_values` is set to `ALL_VALUES_UNSPECIFIED`.

Returns:

value or null for none

setDeniedValues

public ListPolicy setDeniedValues(java.util.List<java.lang.String> deniedValues)

List of values denied at this resource. Can only be set if no values are set for `allowed_values` and `all_values` is set to `ALL_VALUES_UNSPECIFIED`.

Parameters:

deniedValues - deniedValues or null for none

getInheritFromParent

public java.lang.Boolean getInheritFromParent()

Determines the inheritance behavior for this `Policy`. By default, a `ListPolicy` set at a resource supercedes any `Policy` set anywhere up the resource hierarchy. However, if `inherit_from_parent` is set to `true`, then the values from the effective `Policy` of the parent resource are inherited, meaning the values set in this `Policy` are added to the values inherited up the hierarchy. Setting `Policy` hierarchies that inherit both allowed values and denied values isn't recommended in most circumstances to keep the configuration simple and understandable. However, it is possible to set a `Policy` with `allowed_values` set that inherits a `Policy` with `denied_values` set. In this case, the values that are allowed must be in `allowed_values` and not present in `denied_values`. For example, suppose you have a `Constraint` `constraints/serviceuser.services`, which has a `constraint_type` of `list_constraint`, and with `constraint_default` set to `ALLOW`. Suppose that at the Organization level, a `Policy` is applied that restricts the allowed API activations to {`E1`, `E2`}. Then, if a `Policy` is applied to a project below the Organization that has `inherit_from_parent` set to `false` and field all_values set to DENY, then an attempt to activate any API will be denied. The following examples demonstrate different possible layerings: Example 1 (no inherited values): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} ``projects/bar`` has `inherit_from_parent` `false` and values: {allowed_values: "E3" allowed_values: "E4"} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are `E3`, and `E4`. Example 2 (inherited values): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has a `Policy` with values: {value: “E3” value: ”E4” inherit_from_parent: true} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`. Example 3 (inheriting both allowed and denied values): `organizations/foo` has a `Policy` with values: {allowed_values: "E1" allowed_values: "E2"} `projects/bar` has a `Policy` with: {denied_values: "E1"} The accepted values at `organizations/foo` are `E1`, `E2`. The value accepted at `projects/bar` is `E2`. Example 4 (RestoreDefault): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has a `Policy` with values: {RestoreDefault: {}} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are either all or none depending on the value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 5 (no policy inherits parent policy): `organizations/foo` has no `Policy` set. `projects/bar` has no `Policy` set. The accepted values at both levels are either all or none depending on the value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 6 (ListConstraint allowing all): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values: ”E2”} `projects/bar` has a `Policy` with: {all: ALLOW} The accepted values at `organizations/foo` are `E1`, E2`. Any value is accepted at `projects/bar`. Example 7 (ListConstraint allowing none): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values: ”E2”} `projects/bar` has a `Policy` with: {all: DENY} The accepted values at `organizations/foo` are `E1`, E2`. No value is accepted at `projects/bar`.

Returns:

value or null for none

setInheritFromParent

public ListPolicy setInheritFromParent(java.lang.Boolean inheritFromParent)

Determines the inheritance behavior for this `Policy`. By default, a `ListPolicy` set at a resource supercedes any `Policy` set anywhere up the resource hierarchy. However, if `inherit_from_parent` is set to `true`, then the values from the effective `Policy` of the parent resource are inherited, meaning the values set in this `Policy` are added to the values inherited up the hierarchy. Setting `Policy` hierarchies that inherit both allowed values and denied values isn't recommended in most circumstances to keep the configuration simple and understandable. However, it is possible to set a `Policy` with `allowed_values` set that inherits a `Policy` with `denied_values` set. In this case, the values that are allowed must be in `allowed_values` and not present in `denied_values`. For example, suppose you have a `Constraint` `constraints/serviceuser.services`, which has a `constraint_type` of `list_constraint`, and with `constraint_default` set to `ALLOW`. Suppose that at the Organization level, a `Policy` is applied that restricts the allowed API activations to {`E1`, `E2`}. Then, if a `Policy` is applied to a project below the Organization that has `inherit_from_parent` set to `false` and field all_values set to DENY, then an attempt to activate any API will be denied. The following examples demonstrate different possible layerings: Example 1 (no inherited values): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} ``projects/bar`` has `inherit_from_parent` `false` and values: {allowed_values: "E3" allowed_values: "E4"} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are `E3`, and `E4`. Example 2 (inherited values): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has a `Policy` with values: {value: “E3” value: ”E4” inherit_from_parent: true} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`. Example 3 (inheriting both allowed and denied values): `organizations/foo` has a `Policy` with values: {allowed_values: "E1" allowed_values: "E2"} `projects/bar` has a `Policy` with: {denied_values: "E1"} The accepted values at `organizations/foo` are `E1`, `E2`. The value accepted at `projects/bar` is `E2`. Example 4 (RestoreDefault): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has a `Policy` with values: {RestoreDefault: {}} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are either all or none depending on the value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 5 (no policy inherits parent policy): `organizations/foo` has no `Policy` set. `projects/bar` has no `Policy` set. The accepted values at both levels are either all or none depending on the value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 6 (ListConstraint allowing all): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values: ”E2”} `projects/bar` has a `Policy` with: {all: ALLOW} The accepted values at `organizations/foo` are `E1`, E2`. Any value is accepted at `projects/bar`. Example 7 (ListConstraint allowing none): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values: ”E2”} `projects/bar` has a `Policy` with: {all: DENY} The accepted values at `organizations/foo` are `E1`, E2`. No value is accepted at `projects/bar`.

Parameters:

inheritFromParent - inheritFromParent or null for none

getSuggestedValue

public java.lang.String getSuggestedValue()

Optional. The Google Cloud Console will try to default to a configuration that matches the value specified in this `Policy`. If `suggested_value` is not set, it will inherit the value specified higher in the hierarchy, unless `inherit_from_parent` is `false`.

Returns:

value or null for none

setSuggestedValue

public ListPolicy setSuggestedValue(java.lang.String suggestedValue)

Optional. The Google Cloud Console will try to default to a configuration that matches the value specified in this `Policy`. If `suggested_value` is not set, it will inherit the value specified higher in the hierarchy, unless `inherit_from_parent` is `false`.

Parameters:

suggestedValue - suggestedValue or null for none

set

public ListPolicy set(java.lang.String fieldName,
             java.lang.Object value)

Overrides:

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

clone

public ListPolicy clone()

Overrides:

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