Package com.google.cloud.discoveryengine.v1

Class CmekConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1.CmekConfig
All Implemented Interfaces:
CmekConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class CmekConfig extends com.google.protobuf.GeneratedMessage implements CmekConfigOrBuilder
 Configurations used to enable CMEK data encryption with Cloud KMS keys.
Protobuf type google.cloud.discoveryengine.v1.CmekConfig
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • KMS_KEY_FIELD_NUMBER

      public static final int KMS_KEY_FIELD_NUMBER
      See Also:

    • KMS_KEY_VERSION_FIELD_NUMBER

      public static final int KMS_KEY_VERSION_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • IS_DEFAULT_FIELD_NUMBER

      public static final int IS_DEFAULT_FIELD_NUMBER
      See Also:

    • LAST_ROTATION_TIMESTAMP_MICROS_FIELD_NUMBER

      public static final int LAST_ROTATION_TIMESTAMP_MICROS_FIELD_NUMBER
      See Also:

    • SINGLE_REGION_KEYS_FIELD_NUMBER

      public static final int SINGLE_REGION_KEYS_FIELD_NUMBER
      See Also:

    • NOTEBOOKLM_STATE_FIELD_NUMBER

      public static final int NOTEBOOKLM_STATE_FIELD_NUMBER
      See Also:

  • 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

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

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

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

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

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

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

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

    • 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

    • 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

    • 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

    • 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

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

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

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static CmekConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CmekConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CmekConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CmekConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CmekConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CmekConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CmekConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CmekConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CmekConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CmekConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CmekConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CmekConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static CmekConfig.Builder newBuilder()

    • newBuilder

      public static CmekConfig.Builder newBuilder(CmekConfig prototype)

    • toBuilder

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

    • newBuilderForType

      protected CmekConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static CmekConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<CmekConfig> parser()

    • getParserForType

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

    • getDefaultInstanceForType

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