com.google.api.services.accesscontextmanager.v1.model

Class AccessPolicy

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.accesscontextmanager.v1.model.AccessPolicy

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

`AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use Google Cloud services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization.

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 Access Context 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
AccessPolicy()

Method Summary

Modifier and Type	Method and Description
AccessPolicy	clone()
String	getEtag() Output only.
String	getName() Output only.
String	getParent() Required.
List<String>	getScopes() The scopes of the AccessPolicy.
String	getTitle() Required.
AccessPolicy	set(String fieldName, Object value)
AccessPolicy	setEtag(String etag) Output only.
AccessPolicy	setName(String name) Output only.
AccessPolicy	setParent(String parent) Required.
AccessPolicy	setScopes(List<String> scopes) The scopes of the AccessPolicy.
AccessPolicy	setTitle(String title) Required.

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

AccessPolicy

public AccessPolicy()

Method Detail

getEtag

public String getEtag()

Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Polices will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.

Returns:

value or null for none

setEtag

public AccessPolicy setEtag(String etag)

Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Polices will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.

Parameters:

etag - etag or null for none

getName

public String getName()

Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}`

Returns:

value or null for none

setName

public AccessPolicy setName(String name)

Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}`

Parameters:

name - name or null for none

getParent

public String getParent()

Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}`

Returns:

value or null for none

setParent

public AccessPolicy setParent(String parent)

Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}`

Parameters:

parent - parent or null for none

getScopes

public List<String> getScopes()

The scopes of the AccessPolicy. Scopes define which resources a policy can restrict and where its resources can be referenced. For example, policy A with `scopes=["folders/123"]` has the following behavior: - ServicePerimeter can only restrict projects within `folders/123`. - ServicePerimeter within policy A can only reference access levels defined within policy A. - Only one policy can include a given scope; thus, attempting to create a second policy which includes `folders/123` will result in an error. If no scopes are provided, then any resource within the organization can be restricted. Scopes cannot be modified after a policy is created. Policies can only have a single scope. Format: list of `folders/{folder_number}` or `projects/{project_number}`

Returns:

value or null for none

setScopes

public AccessPolicy setScopes(List<String> scopes)

The scopes of the AccessPolicy. Scopes define which resources a policy can restrict and where its resources can be referenced. For example, policy A with `scopes=["folders/123"]` has the following behavior: - ServicePerimeter can only restrict projects within `folders/123`. - ServicePerimeter within policy A can only reference access levels defined within policy A. - Only one policy can include a given scope; thus, attempting to create a second policy which includes `folders/123` will result in an error. If no scopes are provided, then any resource within the organization can be restricted. Scopes cannot be modified after a policy is created. Policies can only have a single scope. Format: list of `folders/{folder_number}` or `projects/{project_number}`

Parameters:

scopes - scopes or null for none

getTitle

public String getTitle()

Required. Human readable title. Does not affect behavior.

Returns:

value or null for none

setTitle

public AccessPolicy setTitle(String title)

Required. Human readable title. Does not affect behavior.

Parameters:

title - title or null for none

set

public AccessPolicy set(String fieldName,
                        Object value)

Overrides:

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

clone

public AccessPolicy clone()

Overrides:

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