Class CmekConfig.Builder (0.60.0)

public static final class CmekConfig.Builder extends GeneratedMessageV3.Builder<CmekConfig.Builder> implements CmekConfigOrBuilder

Configurations used to enable CMEK data encryption with Cloud KMS keys.

Protobuf type google.cloud.discoveryengine.v1.CmekConfig

Implements

CmekConfigOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllSingleRegionKeys(Iterable<? extends SingleRegionKey> values)

public CmekConfig.Builder addAllSingleRegionKeys(Iterable<? extends SingleRegionKey> values)

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
values Iterable<? extends com.google.cloud.discoveryengine.v1.SingleRegionKey>
Returns
Type Description
CmekConfig.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CmekConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CmekConfig.Builder
Overrides

addSingleRegionKeys(SingleRegionKey value)

public CmekConfig.Builder addSingleRegionKeys(SingleRegionKey value)

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
value SingleRegionKey
Returns
Type Description
CmekConfig.Builder

addSingleRegionKeys(SingleRegionKey.Builder builderForValue)

public CmekConfig.Builder addSingleRegionKeys(SingleRegionKey.Builder builderForValue)

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
builderForValue SingleRegionKey.Builder
Returns
Type Description
CmekConfig.Builder

addSingleRegionKeys(int index, SingleRegionKey value)

public CmekConfig.Builder addSingleRegionKeys(int index, SingleRegionKey value)

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

Parameters
Name Description
index int
value SingleRegionKey
Returns
Type Description
CmekConfig.Builder

addSingleRegionKeys(int index, SingleRegionKey.Builder builderForValue)

public CmekConfig.Builder addSingleRegionKeys(int index, SingleRegionKey.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue SingleRegionKey.Builder
Returns
Type Description
CmekConfig.Builder

addSingleRegionKeysBuilder()

public SingleRegionKey.Builder addSingleRegionKeysBuilder()

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
SingleRegionKey.Builder

addSingleRegionKeysBuilder(int index)

public SingleRegionKey.Builder addSingleRegionKeysBuilder(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.Builder

build()

public CmekConfig build()
Returns
Type Description
CmekConfig

buildPartial()

public CmekConfig buildPartial()
Returns
Type Description
CmekConfig

clear()

public CmekConfig.Builder clear()
Returns
Type Description
CmekConfig.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public CmekConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CmekConfig.Builder
Overrides

clearIsDefault()

public CmekConfig.Builder clearIsDefault()

Output only. The default CmekConfig for the Customer.

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

Returns
Type Description
CmekConfig.Builder

This builder for chaining.

clearKmsKey()

public CmekConfig.Builder clearKmsKey()

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
CmekConfig.Builder

This builder for chaining.

clearKmsKeyVersion()

public CmekConfig.Builder clearKmsKeyVersion()

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
CmekConfig.Builder

This builder for chaining.

clearLastRotationTimestampMicros()

public CmekConfig.Builder clearLastRotationTimestampMicros()

Output only. The timestamp of the last key rotation.

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

Returns
Type Description
CmekConfig.Builder

This builder for chaining.

clearName()

public CmekConfig.Builder clearName()

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
CmekConfig.Builder

This builder for chaining.

clearNotebooklmState()

public CmekConfig.Builder clearNotebooklmState()

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.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CmekConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CmekConfig.Builder
Overrides

clearSingleRegionKeys()

public CmekConfig.Builder clearSingleRegionKeys()

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
CmekConfig.Builder

clearState()

public CmekConfig.Builder clearState()

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.Builder

This builder for chaining.

clone()

public CmekConfig.Builder clone()
Returns
Type Description
CmekConfig.Builder
Overrides

getDefaultInstanceForType()

public CmekConfig getDefaultInstanceForType()
Returns
Type Description
CmekConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getIsDefault()

public 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 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 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 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 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 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 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 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 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 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 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

getSingleRegionKeysBuilder(int index)

public SingleRegionKey.Builder getSingleRegionKeysBuilder(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.Builder

getSingleRegionKeysBuilderList()

public List<SingleRegionKey.Builder> getSingleRegionKeysBuilderList()

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<Builder>

getSingleRegionKeysCount()

public 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 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 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 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CmekConfig other)

public CmekConfig.Builder mergeFrom(CmekConfig other)
Parameter
Name Description
other CmekConfig
Returns
Type Description
CmekConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CmekConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CmekConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CmekConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CmekConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CmekConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CmekConfig.Builder
Overrides

removeSingleRegionKeys(int index)

public CmekConfig.Builder removeSingleRegionKeys(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
CmekConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public CmekConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CmekConfig.Builder
Overrides

setIsDefault(boolean value)

public CmekConfig.Builder setIsDefault(boolean value)

Output only. The default CmekConfig for the Customer.

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

Parameter
Name Description
value boolean

The isDefault to set.

Returns
Type Description
CmekConfig.Builder

This builder for chaining.

setKmsKey(String value)

public CmekConfig.Builder setKmsKey(String value)

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) = { ... }

Parameter
Name Description
value String

The kmsKey to set.

Returns
Type Description
CmekConfig.Builder

This builder for chaining.

setKmsKeyBytes(ByteString value)

public CmekConfig.Builder setKmsKeyBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for kmsKey to set.

Returns
Type Description
CmekConfig.Builder

This builder for chaining.

setKmsKeyVersion(String value)

public CmekConfig.Builder setKmsKeyVersion(String value)

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) = { ... }

Parameter
Name Description
value String

The kmsKeyVersion to set.

Returns
Type Description
CmekConfig.Builder

This builder for chaining.

setKmsKeyVersionBytes(ByteString value)

public CmekConfig.Builder setKmsKeyVersionBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for kmsKeyVersion to set.

Returns
Type Description
CmekConfig.Builder

This builder for chaining.

setLastRotationTimestampMicros(long value)

public CmekConfig.Builder setLastRotationTimestampMicros(long value)

Output only. The timestamp of the last key rotation.

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

Parameter
Name Description
value long

The lastRotationTimestampMicros to set.

Returns
Type Description
CmekConfig.Builder

This builder for chaining.

setName(String value)

public CmekConfig.Builder setName(String value)

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
CmekConfig.Builder

This builder for chaining.

setNameBytes(ByteString value)

public CmekConfig.Builder setNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
CmekConfig.Builder

This builder for chaining.

setNotebooklmState(CmekConfig.NotebookLMState value)

public CmekConfig.Builder setNotebooklmState(CmekConfig.NotebookLMState value)

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

Parameter
Name Description
value CmekConfig.NotebookLMState

The notebooklmState to set.

Returns
Type Description
CmekConfig.Builder

This builder for chaining.

setNotebooklmStateValue(int value)

public CmekConfig.Builder setNotebooklmStateValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for notebooklmState to set.

Returns
Type Description
CmekConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CmekConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CmekConfig.Builder
Overrides

setSingleRegionKeys(int index, SingleRegionKey value)

public CmekConfig.Builder setSingleRegionKeys(int index, SingleRegionKey value)

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

Parameters
Name Description
index int
value SingleRegionKey
Returns
Type Description
CmekConfig.Builder

setSingleRegionKeys(int index, SingleRegionKey.Builder builderForValue)

public CmekConfig.Builder setSingleRegionKeys(int index, SingleRegionKey.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue SingleRegionKey.Builder
Returns
Type Description
CmekConfig.Builder

setState(CmekConfig.State value)

public CmekConfig.Builder setState(CmekConfig.State value)

Output only. The states of the CmekConfig.

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

Parameter
Name Description
value CmekConfig.State

The state to set.

Returns
Type Description
CmekConfig.Builder

This builder for chaining.

setStateValue(int value)

public CmekConfig.Builder setStateValue(int value)

Output only. The states of the CmekConfig.

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
CmekConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CmekConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CmekConfig.Builder
Overrides