Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::CmekConfig.
Configurations used to enable CMEK data encryption with Cloud KMS keys.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#is_default
def is_default() -> ::Boolean
Returns
- (::Boolean) — Output only. The default CmekConfig for the Customer.
#kms_key
def kms_key() -> ::String
Returns
-
(::String) — KMS key resource name which will be used to encrypt resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
.
#kms_key=
def kms_key=(value) -> ::String
Parameter
-
value (::String) — KMS key resource name which will be used to encrypt resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
.
Returns
-
(::String) — KMS key resource name which will be used to encrypt resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
.
#kms_key_version
def kms_key_version() -> ::String
Returns
-
(::String) — KMS key version resource name which will be used to encrypt resources
<kms_key>/cryptoKeyVersions/{keyVersion}
.
#kms_key_version=
def kms_key_version=(value) -> ::String
Parameter
-
value (::String) — KMS key version resource name which will be used to encrypt resources
<kms_key>/cryptoKeyVersions/{keyVersion}
.
Returns
-
(::String) — KMS key version resource name which will be used to encrypt resources
<kms_key>/cryptoKeyVersions/{keyVersion}
.
#last_rotation_timestamp_micros
def last_rotation_timestamp_micros() -> ::Integer
Returns
- (::Integer) — Output only. The timestamp of the last key rotation.
#name
def name() -> ::String
Returns
-
(::String) — Required. The name of the CmekConfig of the form
projects/{project}/locations/{location}/cmekConfig
orprojects/{project}/locations/{location}/cmekConfigs/{cmek_config}
.
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Required. The name of the CmekConfig of the form
projects/{project}/locations/{location}/cmekConfig
orprojects/{project}/locations/{location}/cmekConfigs/{cmek_config}
.
Returns
-
(::String) — Required. The name of the CmekConfig of the form
projects/{project}/locations/{location}/cmekConfig
orprojects/{project}/locations/{location}/cmekConfigs/{cmek_config}
.
#notebooklm_state
def notebooklm_state() -> ::Google::Cloud::DiscoveryEngine::V1::CmekConfig::NotebookLMState
Returns
- (::Google::Cloud::DiscoveryEngine::V1::CmekConfig::NotebookLMState) — Output only. Whether the NotebookLM Corpus is ready to be used.
#single_region_keys
def single_region_keys() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::SingleRegionKey>
Returns
- (::Array<::Google::Cloud::DiscoveryEngine::V1::SingleRegionKey>) — Optional. Single-regional CMEKs that are required for some VAIS features.
#single_region_keys=
def single_region_keys=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::SingleRegionKey>
Parameter
- value (::Array<::Google::Cloud::DiscoveryEngine::V1::SingleRegionKey>) — Optional. Single-regional CMEKs that are required for some VAIS features.
Returns
- (::Array<::Google::Cloud::DiscoveryEngine::V1::SingleRegionKey>) — Optional. Single-regional CMEKs that are required for some VAIS features.
#state
def state() -> ::Google::Cloud::DiscoveryEngine::V1::CmekConfig::State
Returns
- (::Google::Cloud::DiscoveryEngine::V1::CmekConfig::State) — Output only. The states of the CmekConfig.