Interface CmekConfigOrBuilder (0.60.0)

public interface CmekConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getIsDefault()

public abstract boolean getIsDefault()

Output only. The default CmekConfig for the Customer.

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

Returns
Type Description
boolean

The isDefault.

getKmsKey()

public abstract 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
Type Description
String

The kmsKey.

getKmsKeyBytes()

public abstract 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
Type Description
ByteString

The bytes for kmsKey.

getKmsKeyVersion()

public abstract 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
Type Description
String

The kmsKeyVersion.

getKmsKeyVersionBytes()

public abstract 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
Type Description
ByteString

The bytes for kmsKeyVersion.

getLastRotationTimestampMicros()

public abstract long getLastRotationTimestampMicros()

Output only. The timestamp of the last key rotation.

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

Returns
Type Description
long

The lastRotationTimestampMicros.

getName()

public abstract 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
Type Description
String

The name.

getNameBytes()

public abstract 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
Type Description
ByteString

The bytes for name.

getNotebooklmState()

public abstract 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
Type Description
CmekConfig.NotebookLMState

The notebooklmState.

getNotebooklmStateValue()

public abstract 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
Type Description
int

The enum numeric value on the wire for notebooklmState.

getSingleRegionKeys(int index)

public abstract 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];

Parameter
Name Description
index int
Returns
Type Description
SingleRegionKey

getSingleRegionKeysCount()

public abstract 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];

Returns
Type Description
int

getSingleRegionKeysList()

public abstract 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];

Returns
Type Description
List<SingleRegionKey>

getSingleRegionKeysOrBuilder(int index)

public abstract 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];

Parameter
Name Description
index int
Returns
Type Description
SingleRegionKeyOrBuilder

getSingleRegionKeysOrBuilderList()

public abstract 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];

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1.SingleRegionKeyOrBuilder>

getState()

public abstract 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
Type Description
CmekConfig.State

The state.

getStateValue()

public abstract int getStateValue()

Output only. The states of the CmekConfig.

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

Returns
Type Description
int

The enum numeric value on the wire for state.