Google Cloud Secure Source Manager V1 Client - Class Instance (1.6.1)

Reference documentation and code samples for the Google Cloud Secure Source Manager V1 Client class Instance.

A resource that represents a Secure Source Manager instance.

Generated from protobuf message google.cloud.securesourcemanager.v1.Instance

Namespace

Google \ Cloud \ SecureSourceManager \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Optional. A unique identifier for an instance. The name should be of the format: `projects/{project_number}/locations/{location_id}/instances/{instance_id}` `project_number`: Maps to a unique int64 id assigned to each project. `location_id`: Refers to the region where the instance will be deployed. Since Secure Source Manager is a regional service, it must be one of the valid GCP regions. `instance_id`: User provided name for the instance, must be unique for a project_number and location_id combination.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. Create timestamp.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. Update timestamp.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Optional. Labels as key value pairs.
`↳ private_config`	`Instance\PrivateConfig` Optional. Private settings for private instance.
`↳ state`	`int` Output only. Current state of the instance.
`↳ state_note`	`int` Output only. An optional field providing information about the current instance state.
`↳ kms_key`	`string` Optional. Immutable. Customer-managed encryption key name, in the format projects//locations//keyRings//cryptoKeys/.
`↳ host_config`	`Instance\HostConfig` Output only. A list of hostnames for this instance.
`↳ workforce_identity_federation_config`	`Instance\WorkforceIdentityFederationConfig` Optional. Configuration for Workforce Identity Federation to support third party identity provider. If unset, defaults to the Google OIDC IdP.

getName

Optional. A unique identifier for an instance. The name should be of the format: projects/{project_number}/locations/{location_id}/instances/{instance_id} project_number: Maps to a unique int64 id assigned to each project.

location_id: Refers to the region where the instance will be deployed. Since Secure Source Manager is a regional service, it must be one of the valid GCP regions. instance_id: User provided name for the instance, must be unique for a project_number and location_id combination.

Returns
Type	Description
`string`

setName

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. Create timestamp.

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

hasCreateTime

clearCreateTime

setCreateTime

Output only. Create timestamp.

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

Returns
Type	Description
`$this`

getUpdateTime

Output only. Update timestamp.

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

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Update timestamp.

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

Returns
Type	Description
`$this`

getLabels

Optional. Labels as key value pairs.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Optional. Labels as key value pairs.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getPrivateConfig

Optional. Private settings for private instance.

Returns
Type	Description
`Instance\PrivateConfig\|null`

hasPrivateConfig

clearPrivateConfig

setPrivateConfig

Optional. Private settings for private instance.

Parameter
Name	Description
`var`	`Instance\PrivateConfig`

Returns
Type	Description
`$this`

getState

Output only. Current state of the instance.

Returns
Type	Description
`int`	Enum of type State.

setState

Output only. Current state of the instance.

Parameter
Name	Description
`var`	`int` Enum of type State.

Returns
Type	Description
`$this`

getStateNote

Output only. An optional field providing information about the current instance state.

Returns
Type	Description
`int`	Enum of type StateNote.

setStateNote