Reference documentation and code samples for the Access Context Manager V1 Client class ServicePerimeter.
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 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.
Generated from protobuf message google.identity.accesscontextmanager.v1.ServicePerimeter
Namespace
Google \ Identity \ AccessContextManager \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. Resource name for the ServicePerimeter. The short_name
component must begin with a letter and only include alphanumeric and '_'. Format: accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}
↳ title
string
Human readable title. Must be unique within the Policy.
↳ description
string
Description of the ServicePerimeter
and its use. Does not affect behavior.
↳ create_time
↳ update_time
↳ perimeter_type
int
Perimeter type indicator. A single project 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.
↳ status
Google\Identity\AccessContextManager\V1\ServicePerimeterConfig
Current ServicePerimeter configuration. Specifies sets of resources, restricted services and access levels that determine perimeter content and boundaries.
↳ spec
Google\Identity\AccessContextManager\V1\ServicePerimeterConfig
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.
↳ use_explicit_dry_run_spec
bool
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.
getName
Required. Resource name for the ServicePerimeter. The short_name
component must begin with a letter and only include alphanumeric and '_'.
Format: accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}
string
setName
Required. Resource name for the ServicePerimeter. The short_name
component must begin with a letter and only include alphanumeric and '_'.
Format: accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}
var
string
$this
getTitle
Human readable title. Must be unique within the Policy.
string
setTitle
Human readable title. Must be unique within the Policy.
var
string
$this
getDescription
Description of the ServicePerimeter
and its use. Does not affect
behavior.
string
setDescription
Description of the ServicePerimeter
and its use. Does not affect
behavior.
var
string
$this
getCreateTime
Output only. Time the ServicePerimeter
was created in UTC.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time the ServicePerimeter
was created in UTC.
$this
getUpdateTime
Output only. Time the ServicePerimeter
was updated in UTC.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Time the ServicePerimeter
was updated in UTC.
$this
getPerimeterType
Perimeter type indicator. A single project 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.
int
setPerimeterType
Perimeter type indicator. A single project 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.
var
int
$this
getStatus
Current ServicePerimeter configuration. Specifies sets of resources, restricted services and access levels that determine perimeter content and boundaries.
hasStatus
clearStatus
setStatus
Current ServicePerimeter configuration. Specifies sets of resources, restricted services and access levels that determine perimeter content and boundaries.
$this
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.
hasSpec
clearSpec
setSpec
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.
$this
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.
bool
setUseExplicitDryRunSpec
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.
var
bool
$this
