Reference documentation and code samples for the Google Cloud Financial Services V1 Client class Instance.
Instance is a container for the rest of API resources.
Only resources in the same instance can interact with each other. Child resources inherit the location (data residency) and encryption (CMEK). The location of the provided input and output in requests must match the location of the instance.
Generated from protobuf message google.cloud.financialservices.v1.Instance
Namespace
Google \ Cloud \ FinancialServices \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The full path to the Instance resource in this API. format: |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Timestamp when the Instance was created. Assigned by the server. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Timestamp when the Instance was last updated. Assigned by the server. |
↳ state |
int
Output only. State of the instance. Assigned by the server. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Labels |
↳ kms_key |
string
Required. The KMS key name used for CMEK (encryption-at-rest). format: |
getName
Output only. The full path to the Instance resource in this API.
format: projects/{project}/locations/{location}/instances/{instance}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Output only. The full path to the Instance resource in this API.
format: projects/{project}/locations/{location}/instances/{instance}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Timestamp when the Instance was created.
Assigned by the server.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when the Instance was created.
Assigned by the server.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Timestamp when the Instance was last updated.
Assigned by the server.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when the Instance was last updated.
Assigned by the server.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. State of the instance.
Assigned by the server.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. State of the instance.
Assigned by the server.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Labels
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Labels
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKmsKey
Required. The KMS key name used for CMEK (encryption-at-rest).
format:
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}
VPC-SC restrictions apply.
| Returns | |
|---|---|
| Type | Description |
string |
|
setKmsKey
Required. The KMS key name used for CMEK (encryption-at-rest).
format:
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}
VPC-SC restrictions apply.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|