Package com.google.cloud.kms.v1

Interface AutokeyConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AutokeyConfig, AutokeyConfig.Builder
@Generated public interface AutokeyConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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];
      Returns:
      The name.

    • getNameBytes

      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];
      Returns:
      The bytes for name.

    • getKeyProject

      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];
      Returns:
      The keyProject.

    • getKeyProjectBytes

      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];
      Returns:
      The bytes for keyProject.

    • getStateValue

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

    • getState

      AutokeyConfig.State getState()
       Output only. The state for the AutokeyConfig.
      .google.cloud.kms.v1.AutokeyConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.

    • getEtag

      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];
      Returns:
      The etag.

    • getEtagBytes

      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];
      Returns:
      The bytes for etag.

    • getKeyProjectResolutionModeValue

      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];
      Returns:
      The enum numeric value on the wire for keyProjectResolutionMode.

    • getKeyProjectResolutionMode

      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];
      Returns:
      The keyProjectResolutionMode.