Reference documentation and code samples for the Google Cloud Net App V1 Client class KmsConfig.
KmsConfig is the customer managed encryption key(CMEK) configuration.
Generated from protobuf message google.cloud.netapp.v1.KmsConfig
Namespace
Google \ Cloud \ NetApp \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. Name of the KmsConfig. |
↳ crypto_key_name |
string
Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}. |
↳ state |
int
Output only. State of the KmsConfig. |
↳ state_details |
string
Output only. State details of the KmsConfig. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Create time of the KmsConfig. |
↳ description |
string
Description of the KmsConfig. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Labels as key value pairs |
↳ instructions |
string
Output only. Instructions to provide the access to the customer provided encryption key. |
↳ service_account |
string
Output only. The Service account which will have access to the customer provided encryption key. |
getName
Identifier. Name of the KmsConfig.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. Name of the KmsConfig.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCryptoKeyName
Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setCryptoKeyName
Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. State of the KmsConfig.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. State of the KmsConfig.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStateDetails
Output only. State details of the KmsConfig.
| Returns | |
|---|---|
| Type | Description |
string |
|
setStateDetails
Output only. State details of the KmsConfig.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Create time of the KmsConfig.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Create time of the KmsConfig.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Description of the KmsConfig.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Description of the KmsConfig.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Labels as key value pairs
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Labels as key value pairs
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInstructions
Output only. Instructions to provide the access to the customer provided encryption key.
| Returns | |
|---|---|
| Type | Description |
string |
|
setInstructions
Output only. Instructions to provide the access to the customer provided encryption key.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getServiceAccount
Output only. The Service account which will have access to the customer provided encryption key.
| Returns | |
|---|---|
| Type | Description |
string |
|
setServiceAccount
Output only. The Service account which will have access to the customer provided encryption key.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|