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

Class ServicePerimeter

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.ServicePerimeter

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

`ServicePerimeter` describes a set of Google Cloud resources which can freely import and export data amongst themselves, but not export outside of the `ServicePerimeter`. If a request with a source within this `ServicePerimeter` has a target outside of the `ServicePerimeter`, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google Cloud project or VPC network can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only Google Cloud projects as members, a single Google Cloud project may belong to multiple Service Perimeter Bridges.

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
ServicePerimeter()

Method Summary

Modifier and Type	Method and Description
ServicePerimeter	clone()
String	getDescription() Description of the `ServicePerimeter` and its use.
String	getName() Resource name for the `ServicePerimeter`.
String	getPerimeterType() Perimeter type indicator.
ServicePerimeterConfig	getSpec() Proposed (or dry run) ServicePerimeter configuration.
ServicePerimeterConfig	getStatus() Current ServicePerimeter configuration.
String	getTitle() Human readable title.
Boolean	getUseExplicitDryRunSpec() Use explicit dry run spec flag.
ServicePerimeter	set(String fieldName, Object value)
ServicePerimeter	setDescription(String description) Description of the `ServicePerimeter` and its use.
ServicePerimeter	setName(String name) Resource name for the `ServicePerimeter`.
ServicePerimeter	setPerimeterType(String perimeterType) Perimeter type indicator.
ServicePerimeter	setSpec(ServicePerimeterConfig spec) Proposed (or dry run) ServicePerimeter configuration.
ServicePerimeter	setStatus(ServicePerimeterConfig status) Current ServicePerimeter configuration.
ServicePerimeter	setTitle(String title) Human readable title.
ServicePerimeter	setUseExplicitDryRunSpec(Boolean useExplicitDryRunSpec) Use explicit dry run spec flag.

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

ServicePerimeter

public ServicePerimeter()

Method Detail

getDescription

public String getDescription()

Description of the `ServicePerimeter` and its use. Does not affect behavior.

Returns:

value or null for none

setDescription

public ServicePerimeter setDescription(String description)

Description of the `ServicePerimeter` and its use. Does not affect behavior.

Parameters:

description - description or null for none

getName

public String getName()

Resource name for the `ServicePerimeter`. Format: `accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}`. The `service_perimeter` component must begin with a letter, followed by alphanumeric characters or `_`. After you create a `ServicePerimeter`, you cannot change its `name`.

Returns:

value or null for none

setName

public ServicePerimeter setName(String name)

Resource name for the `ServicePerimeter`. Format: `accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}`. The `service_perimeter` component must begin with a letter, followed by alphanumeric characters or `_`. After you create a `ServicePerimeter`, you cannot change its `name`.

Parameters:

name - name or null for none

getPerimeterType

public String getPerimeterType()

Perimeter type indicator. A single project or VPC network is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, the restricted service list as well as access level lists must be empty.

Returns:

value or null for none

setPerimeterType

public ServicePerimeter setPerimeterType(String perimeterType)

Perimeter type indicator. A single project or VPC network is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, the restricted service list as well as access level lists must be empty.

Parameters:

perimeterType - perimeterType or null for none

getSpec

public ServicePerimeterConfig getSpec()

Proposed (or dry run) ServicePerimeter configuration. This configuration allows to specify and test ServicePerimeter configuration without enforcing actual access restrictions. Only allowed to be set when the "use_explicit_dry_run_spec" flag is set.

Returns:

value or null for none

setSpec

public ServicePerimeter setSpec(ServicePerimeterConfig spec)

Proposed (or dry run) ServicePerimeter configuration. This configuration allows to specify and test ServicePerimeter configuration without enforcing actual access restrictions. Only allowed to be set when the "use_explicit_dry_run_spec" flag is set.

Parameters:

spec - spec or null for none

getStatus

public ServicePerimeterConfig getStatus()

Current ServicePerimeter configuration. Specifies sets of resources, restricted services and access levels that determine perimeter content and boundaries.

Returns:

value or null for none

setStatus

public ServicePerimeter setStatus(ServicePerimeterConfig status)

Current ServicePerimeter configuration. Specifies sets of resources, restricted services and access levels that determine perimeter content and boundaries.

Parameters:

status - status or null for none

getTitle

public String getTitle()

Human readable title. Must be unique within the Policy.

Returns:

value or null for none

setTitle

public ServicePerimeter setTitle(String title)

Human readable title. Must be unique within the Policy.

Parameters:

title - title or null for none

getUseExplicitDryRunSpec

public Boolean getUseExplicitDryRunSpec()

Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly exists for all Service Perimeters, and that spec is identical to the status for those Service Perimeters. When this flag is set, it inhibits the generation of the implicit spec, thereby allowing the user to explicitly provide a configuration ("spec") to use in a dry-run version of the Service Perimeter. This allows the user to test changes to the enforced config ("status") without actually enforcing them. This testing is done through analyzing the differences between currently enforced and suggested restrictions. use_explicit_dry_run_spec must bet set to True if any of the fields in the spec are set to non-default values.

Returns:

value or null for none

setUseExplicitDryRunSpec

public ServicePerimeter setUseExplicitDryRunSpec(Boolean useExplicitDryRunSpec)

Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly exists for all Service Perimeters, and that spec is identical to the status for those Service Perimeters. When this flag is set, it inhibits the generation of the implicit spec, thereby allowing the user to explicitly provide a configuration ("spec") to use in a dry-run version of the Service Perimeter. This allows the user to test changes to the enforced config ("status") without actually enforcing them. This testing is done through analyzing the differences between currently enforced and suggested restrictions. use_explicit_dry_run_spec must bet set to True if any of the fields in the spec are set to non-default values.

Parameters:

useExplicitDryRunSpec - useExplicitDryRunSpec or null for none

set

public ServicePerimeter set(String fieldName,
                            Object value)

Overrides:

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

clone

public ServicePerimeter clone()

Overrides:

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