Package com.google.cloud.kms.v1

Class AutokeyConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<AutokeyConfig.Builder>
com.google.cloud.kms.v1.AutokeyConfig.Builder
All Implemented Interfaces:
AutokeyConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
AutokeyConfig
public static final class AutokeyConfig.Builder extends com.google.protobuf.GeneratedMessage.Builder<AutokeyConfig.Builder> implements AutokeyConfigOrBuilder
 Cloud KMS Autokey configuration for a folder.
Protobuf type google.cloud.kms.v1.AutokeyConfig

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public AutokeyConfig.Builder mergeFrom(AutokeyConfig other)

    • isInitialized

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

    • mergeFrom

      public AutokeyConfig.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<AutokeyConfig.Builder>
      Throws:
      IOException

    • getName

      public String getName()
       Identifier. Name of the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig]
 resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or
 `projects/{PROJECT_NUMBER}/autokeyConfig`.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getName in interface AutokeyConfigOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Identifier. Name of the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig]
 resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or
 `projects/{PROJECT_NUMBER}/autokeyConfig`.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getNameBytes in interface AutokeyConfigOrBuilder
      Returns:
      The bytes for name.

    • setName

      public AutokeyConfig.Builder setName(String value)
       Identifier. Name of the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig]
 resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or
 `projects/{PROJECT_NUMBER}/autokeyConfig`.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public AutokeyConfig.Builder clearName()
       Identifier. Name of the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig]
 resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or
 `projects/{PROJECT_NUMBER}/autokeyConfig`.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      This builder for chaining.

    • setNameBytes

      public AutokeyConfig.Builder setNameBytes(com.google.protobuf.ByteString value)
       Identifier. Name of the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig]
 resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or
 `projects/{PROJECT_NUMBER}/autokeyConfig`.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getKeyProject

      public String getKeyProject()
       Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or
 `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new
 [CryptoKey][google.cloud.kms.v1.CryptoKey] when a
 [KeyHandle][google.cloud.kms.v1.KeyHandle] is created. On
 [UpdateAutokeyConfig][google.cloud.kms.v1.AutokeyAdmin.UpdateAutokeyConfig],
 the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on
 this key project. Once configured, for Cloud KMS Autokey to function
 properly, this key project must have the Cloud KMS API activated and the
 Cloud KMS Service Agent for this key project must be granted the
 `cloudkms.admin` role (or pertinent permissions). A request with an empty
 key project field will clear the configuration.
      string key_project = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getKeyProject in interface AutokeyConfigOrBuilder
      Returns:
      The keyProject.

    • getKeyProjectBytes

      public com.google.protobuf.ByteString getKeyProjectBytes()
       Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or
 `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new
 [CryptoKey][google.cloud.kms.v1.CryptoKey] when a
 [KeyHandle][google.cloud.kms.v1.KeyHandle] is created. On
 [UpdateAutokeyConfig][google.cloud.kms.v1.AutokeyAdmin.UpdateAutokeyConfig],
 the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on
 this key project. Once configured, for Cloud KMS Autokey to function
 properly, this key project must have the Cloud KMS API activated and the
 Cloud KMS Service Agent for this key project must be granted the
 `cloudkms.admin` role (or pertinent permissions). A request with an empty
 key project field will clear the configuration.
      string key_project = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getKeyProjectBytes in interface AutokeyConfigOrBuilder
      Returns:
      The bytes for keyProject.

    • setKeyProject

      public AutokeyConfig.Builder setKeyProject(String value)
       Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or
 `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new
 [CryptoKey][google.cloud.kms.v1.CryptoKey] when a
 [KeyHandle][google.cloud.kms.v1.KeyHandle] is created. On
 [UpdateAutokeyConfig][google.cloud.kms.v1.AutokeyAdmin.UpdateAutokeyConfig],
 the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on
 this key project. Once configured, for Cloud KMS Autokey to function
 properly, this key project must have the Cloud KMS API activated and the
 Cloud KMS Service Agent for this key project must be granted the
 `cloudkms.admin` role (or pertinent permissions). A request with an empty
 key project field will clear the configuration.
      string key_project = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The keyProject to set.
      Returns:
      This builder for chaining.

    • clearKeyProject

      public AutokeyConfig.Builder clearKeyProject()
       Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or
 `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new
 [CryptoKey][google.cloud.kms.v1.CryptoKey] when a
 [KeyHandle][google.cloud.kms.v1.KeyHandle] is created. On
 [UpdateAutokeyConfig][google.cloud.kms.v1.AutokeyAdmin.UpdateAutokeyConfig],
 the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on
 this key project. Once configured, for Cloud KMS Autokey to function
 properly, this key project must have the Cloud KMS API activated and the
 Cloud KMS Service Agent for this key project must be granted the
 `cloudkms.admin` role (or pertinent permissions). A request with an empty
 key project field will clear the configuration.
      string key_project = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setKeyProjectBytes

      public AutokeyConfig.Builder setKeyProjectBytes(com.google.protobuf.ByteString value)
       Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or
 `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new
 [CryptoKey][google.cloud.kms.v1.CryptoKey] when a
 [KeyHandle][google.cloud.kms.v1.KeyHandle] is created. On
 [UpdateAutokeyConfig][google.cloud.kms.v1.AutokeyAdmin.UpdateAutokeyConfig],
 the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on
 this key project. Once configured, for Cloud KMS Autokey to function
 properly, this key project must have the Cloud KMS API activated and the
 Cloud KMS Service Agent for this key project must be granted the
 `cloudkms.admin` role (or pertinent permissions). A request with an empty
 key project field will clear the configuration.
      string key_project = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for keyProject to set.
      Returns:
      This builder for chaining.

    • getStateValue

      public int getStateValue()
       Output only. The state for the AutokeyConfig.
      .google.cloud.kms.v1.AutokeyConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStateValue in interface AutokeyConfigOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • setStateValue

      public AutokeyConfig.Builder setStateValue(int value)
       Output only. The state for the AutokeyConfig.
      .google.cloud.kms.v1.AutokeyConfig.State state = 4 [(.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 AutokeyConfig.State getState()
       Output only. The state for the AutokeyConfig.
      .google.cloud.kms.v1.AutokeyConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getState in interface AutokeyConfigOrBuilder
      Returns:
      The state.

    • setState

      public AutokeyConfig.Builder setState(AutokeyConfig.State value)
       Output only. The state for the AutokeyConfig.
      .google.cloud.kms.v1.AutokeyConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The state to set.
      Returns:
      This builder for chaining.

    • clearState

      public AutokeyConfig.Builder clearState()
       Output only. The state for the AutokeyConfig.
      .google.cloud.kms.v1.AutokeyConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • getEtag

      public String getEtag()
       Optional. A checksum computed by the server based on the value of other
 fields. This may be sent on update requests to ensure that the client has
 an up-to-date value before proceeding. The request will be rejected with an
 ABORTED error on a mismatched etag.
      string etag = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEtag in interface AutokeyConfigOrBuilder
      Returns:
      The etag.

    • getEtagBytes

      public com.google.protobuf.ByteString getEtagBytes()
       Optional. A checksum computed by the server based on the value of other
 fields. This may be sent on update requests to ensure that the client has
 an up-to-date value before proceeding. The request will be rejected with an
 ABORTED error on a mismatched etag.
      string etag = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEtagBytes in interface AutokeyConfigOrBuilder
      Returns:
      The bytes for etag.

    • setEtag

      public AutokeyConfig.Builder setEtag(String value)
       Optional. A checksum computed by the server based on the value of other
 fields. This may be sent on update requests to ensure that the client has
 an up-to-date value before proceeding. The request will be rejected with an
 ABORTED error on a mismatched etag.
      string etag = 6 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The etag to set.
      Returns:
      This builder for chaining.

    • clearEtag

      public AutokeyConfig.Builder clearEtag()
       Optional. A checksum computed by the server based on the value of other
 fields. This may be sent on update requests to ensure that the client has
 an up-to-date value before proceeding. The request will be rejected with an
 ABORTED error on a mismatched etag.
      string etag = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setEtagBytes

      public AutokeyConfig.Builder setEtagBytes(com.google.protobuf.ByteString value)
       Optional. A checksum computed by the server based on the value of other
 fields. This may be sent on update requests to ensure that the client has
 an up-to-date value before proceeding. The request will be rejected with an
 ABORTED error on a mismatched etag.
      string etag = 6 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for etag to set.
      Returns:
      This builder for chaining.

    • getKeyProjectResolutionModeValue

      public int getKeyProjectResolutionModeValue()
       Optional. KeyProjectResolutionMode for the AutokeyConfig.
 Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or
 `DISABLED`.
      .google.cloud.kms.v1.AutokeyConfig.KeyProjectResolutionMode key_project_resolution_mode = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getKeyProjectResolutionModeValue in interface AutokeyConfigOrBuilder
      Returns:
      The enum numeric value on the wire for keyProjectResolutionMode.

    • setKeyProjectResolutionModeValue

      public AutokeyConfig.Builder setKeyProjectResolutionModeValue(int value)
       Optional. KeyProjectResolutionMode for the AutokeyConfig.
 Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or
 `DISABLED`.
      .google.cloud.kms.v1.AutokeyConfig.KeyProjectResolutionMode key_project_resolution_mode = 8 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The enum numeric value on the wire for keyProjectResolutionMode to set.
      Returns:
      This builder for chaining.

    • getKeyProjectResolutionMode

      public AutokeyConfig.KeyProjectResolutionMode getKeyProjectResolutionMode()
       Optional. KeyProjectResolutionMode for the AutokeyConfig.
 Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or
 `DISABLED`.
      .google.cloud.kms.v1.AutokeyConfig.KeyProjectResolutionMode key_project_resolution_mode = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getKeyProjectResolutionMode in interface AutokeyConfigOrBuilder
      Returns:
      The keyProjectResolutionMode.

    • setKeyProjectResolutionMode

      public AutokeyConfig.Builder setKeyProjectResolutionMode(AutokeyConfig.KeyProjectResolutionMode value)
       Optional. KeyProjectResolutionMode for the AutokeyConfig.
 Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or
 `DISABLED`.
      .google.cloud.kms.v1.AutokeyConfig.KeyProjectResolutionMode key_project_resolution_mode = 8 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The keyProjectResolutionMode to set.
      Returns:
      This builder for chaining.

    • clearKeyProjectResolutionMode

      public AutokeyConfig.Builder clearKeyProjectResolutionMode()
       Optional. KeyProjectResolutionMode for the AutokeyConfig.
 Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or
 `DISABLED`.
      .google.cloud.kms.v1.AutokeyConfig.KeyProjectResolutionMode key_project_resolution_mode = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.