com.google.cloud.discoveryengine.v1

Interface CmekConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

CmekConfig, CmekConfig.Builder

@Generated
public interface CmekConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getIsDefault() Output only.
String	getKmsKey() KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
com.google.protobuf.ByteString	getKmsKeyBytes() KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
String	getKmsKeyVersion() KMS key version resource name which will be used to encrypt resources `<kms_key>/cryptoKeyVersions/{keyVersion}`.
com.google.protobuf.ByteString	getKmsKeyVersionBytes() KMS key version resource name which will be used to encrypt resources `<kms_key>/cryptoKeyVersions/{keyVersion}`.
long	getLastRotationTimestampMicros() Output only.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
CmekConfig.NotebookLMState	getNotebooklmState() Output only.
int	getNotebooklmStateValue() Output only.
SingleRegionKey	getSingleRegionKeys(int index) Optional.
int	getSingleRegionKeysCount() Optional.
List<SingleRegionKey>	getSingleRegionKeysList() Optional.
SingleRegionKeyOrBuilder	getSingleRegionKeysOrBuilder(int index) Optional.
List<? extends SingleRegionKeyOrBuilder>	getSingleRegionKeysOrBuilderList() Optional.
CmekConfig.State	getState() Output only.
int	getStateValue() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Required. The name of the CmekConfig of the form
 `projects/{project}/locations/{location}/cmekConfig` or
 `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
 

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Required. The name of the CmekConfig of the form
 `projects/{project}/locations/{location}/cmekConfig` or
 `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
 

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for name.

getKmsKey

String getKmsKey()

 KMS key resource name which will be used to encrypt resources
 `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
 

string kms_key = 2 [(.google.api.resource_reference) = { ... }

Returns:

The kmsKey.

getKmsKeyBytes

com.google.protobuf.ByteString getKmsKeyBytes()

 KMS key resource name which will be used to encrypt resources
 `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
 

string kms_key = 2 [(.google.api.resource_reference) = { ... }

Returns:

The bytes for kmsKey.

getKmsKeyVersion

String getKmsKeyVersion()

 KMS key version resource name which will be used to encrypt resources
 `<kms_key>/cryptoKeyVersions/{keyVersion}`.
 

string kms_key_version = 6 [(.google.api.resource_reference) = { ... }

Returns:

The kmsKeyVersion.

getKmsKeyVersionBytes

com.google.protobuf.ByteString getKmsKeyVersionBytes()

 KMS key version resource name which will be used to encrypt resources
 `<kms_key>/cryptoKeyVersions/{keyVersion}`.
 

string kms_key_version = 6 [(.google.api.resource_reference) = { ... }

Returns:

The bytes for kmsKeyVersion.

getStateValue

int getStateValue()

 Output only. The states of the CmekConfig.
 

.google.cloud.discoveryengine.v1.CmekConfig.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The enum numeric value on the wire for state.

getState

CmekConfig.State getState()

 Output only. The states of the CmekConfig.
 

.google.cloud.discoveryengine.v1.CmekConfig.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The state.

getIsDefault

boolean getIsDefault()

 Output only. The default CmekConfig for the Customer.
 

bool is_default = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The isDefault.

getLastRotationTimestampMicros

long getLastRotationTimestampMicros()

 Output only. The timestamp of the last key rotation.
 

int64 last_rotation_timestamp_micros = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The lastRotationTimestampMicros.

getSingleRegionKeysList

List<SingleRegionKey> getSingleRegionKeysList()

 Optional. Single-regional CMEKs that are required for some VAIS features.
 

repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];

getSingleRegionKeys

SingleRegionKey getSingleRegionKeys(int index)

 Optional. Single-regional CMEKs that are required for some VAIS features.
 

repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];

getSingleRegionKeysCount

int getSingleRegionKeysCount()

 Optional. Single-regional CMEKs that are required for some VAIS features.
 

repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];

getSingleRegionKeysOrBuilderList

List<? extends SingleRegionKeyOrBuilder> getSingleRegionKeysOrBuilderList()

 Optional. Single-regional CMEKs that are required for some VAIS features.
 

repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];

getSingleRegionKeysOrBuilder

SingleRegionKeyOrBuilder getSingleRegionKeysOrBuilder(int index)

 Optional. Single-regional CMEKs that are required for some VAIS features.
 

repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];

getNotebooklmStateValue

int getNotebooklmStateValue()

 Output only. Whether the NotebookLM Corpus is ready to be used.
 

.google.cloud.discoveryengine.v1.CmekConfig.NotebookLMState notebooklm_state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The enum numeric value on the wire for notebooklmState.

getNotebooklmState

CmekConfig.NotebookLMState getNotebooklmState()

 Output only. Whether the NotebookLM Corpus is ready to be used.
 

.google.cloud.discoveryengine.v1.CmekConfig.NotebookLMState notebooklm_state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The notebooklmState.