Access Context Manager V1 Client - Class ServicePerimeter (1.0.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`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`	`Google\Protobuf\Timestamp` Output only. Time the `ServicePerimeter` was created in UTC.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. Time the `ServicePerimeter` was updated in UTC.
`↳ 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}

Returns
Type	Description
`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}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTitle

Human readable title. Must be unique within the Policy.

Returns
Type	Description
`string`

setTitle

Human readable title. Must be unique within the Policy.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

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

Returns
Type	Description
`string`

setDescription

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. Time the ServicePerimeter was created in UTC.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time the ServicePerimeter was created in UTC.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. Time the ServicePerimeter was updated in UTC.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Time the ServicePerimeter was updated in UTC.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$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.

Returns
Type	Description
`int`

setPerimeterType

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getStatus

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

Returns
Type	Description
`Google\Identity\AccessContextManager\V1\ServicePerimeterConfig\|null`

hasStatus

clearStatus

setStatus

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

Parameter
Name	Description
`var`	`Google\Identity\AccessContextManager\V1\ServicePerimeterConfig`

Returns
Type	Description
`$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.

Returns
Type	Description
`Google\Identity\AccessContextManager\V1\ServicePerimeterConfig\|null`

hasSpec

clearSpec

setSpec

Parameter
Name	Description
`var`	`Google\Identity\AccessContextManager\V1\ServicePerimeterConfig`

Returns
Type	Description
`$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.

Returns
Type	Description
`bool`

setUseExplicitDryRunSpec

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`