Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class CmekConfig.
Configurations used to enable CMEK data encryption with Cloud KMS keys.
Generated from protobuf message google.cloud.discoveryengine.v1.CmekConfig
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The name of the CmekConfig of the form |
↳ kms_key |
string
KMS key resource name which will be used to encrypt resources |
↳ kms_key_version |
string
KMS key version resource name which will be used to encrypt resources |
↳ state |
int
Output only. The states of the CmekConfig. |
↳ is_default |
bool
Output only. The default CmekConfig for the Customer. |
↳ last_rotation_timestamp_micros |
int|string
Output only. The timestamp of the last key rotation. |
↳ single_region_keys |
array<SingleRegionKey>
Optional. Single-regional CMEKs that are required for some VAIS features. |
↳ notebooklm_state |
int
Output only. Whether the NotebookLM Corpus is ready to be used. |
getName
Required. The name of the CmekConfig of the form
projects/{project}/locations/{location}/cmekConfig
or
projects/{project}/locations/{location}/cmekConfigs/{cmek_config}
.
Returns | |
---|---|
Type | Description |
string |
setName
Required. The name of the CmekConfig of the form
projects/{project}/locations/{location}/cmekConfig
or
projects/{project}/locations/{location}/cmekConfigs/{cmek_config}
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getKmsKey
KMS key resource name which will be used to encrypt resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
.
Returns | |
---|---|
Type | Description |
string |
setKmsKey
KMS key resource name which will be used to encrypt resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getKmsKeyVersion
KMS key version resource name which will be used to encrypt resources
<kms_key>/cryptoKeyVersions/{keyVersion}
.
Returns | |
---|---|
Type | Description |
string |
setKmsKeyVersion
KMS key version resource name which will be used to encrypt resources
<kms_key>/cryptoKeyVersions/{keyVersion}
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getState
Output only. The states of the CmekConfig.
Returns | |
---|---|
Type | Description |
int |
setState
Output only. The states of the CmekConfig.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getIsDefault
Output only. The default CmekConfig for the Customer.
Returns | |
---|---|
Type | Description |
bool |
setIsDefault
Output only. The default CmekConfig for the Customer.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getLastRotationTimestampMicros
Output only. The timestamp of the last key rotation.
Returns | |
---|---|
Type | Description |
int|string |
setLastRotationTimestampMicros
Output only. The timestamp of the last key rotation.
Parameter | |
---|---|
Name | Description |
var |
int|string
|
Returns | |
---|---|
Type | Description |
$this |
getSingleRegionKeys
Optional. Single-regional CMEKs that are required for some VAIS features.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setSingleRegionKeys
Optional. Single-regional CMEKs that are required for some VAIS features.
Parameter | |
---|---|
Name | Description |
var |
array<SingleRegionKey>
|
Returns | |
---|---|
Type | Description |
$this |
getNotebooklmState
Output only. Whether the NotebookLM Corpus is ready to be used.
Returns | |
---|---|
Type | Description |
int |
setNotebooklmState
Output only. Whether the NotebookLM Corpus is ready to be used.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |