Package com.google.cloud.discoveryengine.v1

Class CmekConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<CmekConfig.Builder>
com.google.cloud.discoveryengine.v1.CmekConfig.Builder
All Implemented Interfaces:
CmekConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
CmekConfig
public static final class CmekConfig.Builder extends com.google.protobuf.GeneratedMessage.Builder<CmekConfig.Builder> implements CmekConfigOrBuilder
 Configurations used to enable CMEK data encryption with Cloud KMS keys.
Protobuf type google.cloud.discoveryengine.v1.CmekConfig

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<CmekConfig.Builder>

    • clear

      public CmekConfig.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<CmekConfig.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<CmekConfig.Builder>

    • getDefaultInstanceForType

      public CmekConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public CmekConfig build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public CmekConfig buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public CmekConfig.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CmekConfig.Builder>

    • mergeFrom

      public CmekConfig.Builder mergeFrom(CmekConfig other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<CmekConfig.Builder>

    • mergeFrom

      public CmekConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CmekConfig.Builder>
      Throws:
      IOException

    • 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];
      Specified by:
      getName in interface CmekConfigOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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];
      Specified by:
      getNameBytes in interface CmekConfigOrBuilder
      Returns:
      The bytes for name.

    • setName

      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];
      Parameters:
      value - The name to set.
      Returns:
      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:
      This builder for chaining.

    • setNameBytes

      public CmekConfig.Builder setNameBytes(com.google.protobuf.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];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • 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) = { ... }
      Specified by:
      getKmsKey in interface CmekConfigOrBuilder
      Returns:
      The kmsKey.

    • getKmsKeyBytes

      public 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) = { ... }
      Specified by:
      getKmsKeyBytes in interface CmekConfigOrBuilder
      Returns:
      The bytes for kmsKey.

    • setKmsKey

      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) = { ... }
      Parameters:
      value - The kmsKey to set.
      Returns:
      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:
      This builder for chaining.

    • setKmsKeyBytes

      public CmekConfig.Builder setKmsKeyBytes(com.google.protobuf.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) = { ... }
      Parameters:
      value - The bytes for kmsKey to set.
      Returns:
      This builder for chaining.

    • 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) = { ... }
      Specified by:
      getKmsKeyVersion in interface CmekConfigOrBuilder
      Returns:
      The kmsKeyVersion.

    • getKmsKeyVersionBytes

      public 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) = { ... }
      Specified by:
      getKmsKeyVersionBytes in interface CmekConfigOrBuilder
      Returns:
      The bytes for kmsKeyVersion.

    • setKmsKeyVersion

      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) = { ... }
      Parameters:
      value - The kmsKeyVersion to set.
      Returns:
      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:
      This builder for chaining.

    • setKmsKeyVersionBytes

      public CmekConfig.Builder setKmsKeyVersionBytes(com.google.protobuf.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) = { ... }
      Parameters:
      value - The bytes for kmsKeyVersion to set.
      Returns:
      This builder for chaining.

    • 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];
      Specified by:
      getStateValue in interface CmekConfigOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • setStateValue

      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];
      Parameters:
      value - The enum numeric value on the wire for state to set.
      Returns:
      This builder for chaining.

    • 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];
      Specified by:
      getState in interface CmekConfigOrBuilder
      Returns:
      The state.

    • setState

      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];
      Parameters:
      value - The state to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

    • getIsDefault

      public boolean getIsDefault()
       Output only. The default CmekConfig for the Customer.
      bool is_default = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getIsDefault in interface CmekConfigOrBuilder
      Returns:
      The isDefault.

    • setIsDefault

      public CmekConfig.Builder setIsDefault(boolean value)
       Output only. The default CmekConfig for the Customer.
      bool is_default = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The isDefault to set.
      Returns:
      This builder for chaining.

    • clearIsDefault

      public CmekConfig.Builder clearIsDefault()
       Output only. The default CmekConfig for the Customer.
      bool is_default = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • 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];
      Specified by:
      getLastRotationTimestampMicros in interface CmekConfigOrBuilder
      Returns:
      The lastRotationTimestampMicros.

    • setLastRotationTimestampMicros

      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];
      Parameters:
      value - The lastRotationTimestampMicros to set.
      Returns:
      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:
      This builder for chaining.

    • 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];
      Specified by:
      getSingleRegionKeysList in interface CmekConfigOrBuilder

    • 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];
      Specified by:
      getSingleRegionKeysCount in interface CmekConfigOrBuilder

    • getSingleRegionKeys

      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];
      Specified by:
      getSingleRegionKeys in interface CmekConfigOrBuilder

    • setSingleRegionKeys

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

    • setSingleRegionKeys

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

    • addSingleRegionKeys

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

    • addSingleRegionKeys

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

    • addSingleRegionKeys

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

    • addSingleRegionKeys

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

    • addAllSingleRegionKeys

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

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

    • removeSingleRegionKeys

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

    • getSingleRegionKeysBuilder

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

    • getSingleRegionKeysOrBuilder

      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];
      Specified by:
      getSingleRegionKeysOrBuilder in interface CmekConfigOrBuilder

    • 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];
      Specified by:
      getSingleRegionKeysOrBuilderList in interface CmekConfigOrBuilder

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

    • addSingleRegionKeysBuilder

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

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

    • 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];
      Specified by:
      getNotebooklmStateValue in interface CmekConfigOrBuilder
      Returns:
      The enum numeric value on the wire for notebooklmState.

    • setNotebooklmStateValue

      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];
      Parameters:
      value - The enum numeric value on the wire for notebooklmState to set.
      Returns:
      This builder for chaining.

    • 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];
      Specified by:
      getNotebooklmState in interface CmekConfigOrBuilder
      Returns:
      The notebooklmState.

    • setNotebooklmState

      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];
      Parameters:
      value - The notebooklmState to set.
      Returns:
      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:
      This builder for chaining.