Reference documentation and code samples for the Google Cloud Dataplex V1 Client class EncryptionConfig.
A Resource designed to manage encryption configurations for customers to support Customer Managed Encryption Keys (CMEK).
Generated from protobuf message google.cloud.dataplex.v1.EncryptionConfig
Namespace
Google \ Cloud \ Dataplex \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name of the EncryptionConfig. Format: organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config} Global location is not supported. |
↳ key |
string
Optional. If a key is chosen, it means that the customer is using CMEK. If a key is not chosen, it means that the customer is using Google managed encryption. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time when the Encryption configuration was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The time when the Encryption configuration was last updated. |
↳ encryption_state |
int
Output only. The state of encryption of the databases. |
↳ etag |
string
Etag of the EncryptionConfig. This is a strong etag. |
↳ failure_details |
EncryptionConfig\FailureDetails
Output only. Details of the failure if anything related to Cmek db fails. |
getName
Identifier. The resource name of the EncryptionConfig.
Format: organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config} Global location is not supported.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the EncryptionConfig.
Format: organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config} Global location is not supported.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKey
Optional. If a key is chosen, it means that the customer is using CMEK.
If a key is not chosen, it means that the customer is using Google managed encryption.
| Returns | |
|---|---|
| Type | Description |
string |
|
setKey
Optional. If a key is chosen, it means that the customer is using CMEK.
If a key is not chosen, it means that the customer is using Google managed encryption.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The time when the Encryption configuration was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the Encryption configuration was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The time when the Encryption configuration was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time when the Encryption configuration was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEncryptionState
Output only. The state of encryption of the databases.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type EncryptionState. |
setEncryptionState
Output only. The state of encryption of the databases.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type EncryptionState. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEtag
Etag of the EncryptionConfig. This is a strong etag.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEtag
Etag of the EncryptionConfig. This is a strong etag.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFailureDetails
Output only. Details of the failure if anything related to Cmek db fails.
| Returns | |
|---|---|
| Type | Description |
EncryptionConfig\FailureDetails|null |
|
hasFailureDetails
clearFailureDetails
setFailureDetails
Output only. Details of the failure if anything related to Cmek db fails.
| Parameter | |
|---|---|
| Name | Description |
var |
EncryptionConfig\FailureDetails
|
| Returns | |
|---|---|
| Type | Description |
$this |
|