Package com.google.cloud.kms.v1

Class CreateCryptoKeyRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<CreateCryptoKeyRequest.Builder>
com.google.cloud.kms.v1.CreateCryptoKeyRequest.Builder
All Implemented Interfaces:
CreateCryptoKeyRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
CreateCryptoKeyRequest
public static final class CreateCryptoKeyRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<CreateCryptoKeyRequest.Builder> implements CreateCryptoKeyRequestOrBuilder
 Request message for
 [KeyManagementService.CreateCryptoKey][google.cloud.kms.v1.KeyManagementService.CreateCryptoKey].
Protobuf type google.cloud.kms.v1.CreateCryptoKeyRequest

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public CreateCryptoKeyRequest.Builder mergeFrom(CreateCryptoKeyRequest other)

    • isInitialized

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

    • mergeFrom

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

    • getParent

      public String getParent()
       Required. The [name][google.cloud.kms.v1.KeyRing.name] of the KeyRing
 associated with the [CryptoKeys][google.cloud.kms.v1.CryptoKey].
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface CreateCryptoKeyRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. The [name][google.cloud.kms.v1.KeyRing.name] of the KeyRing
 associated with the [CryptoKeys][google.cloud.kms.v1.CryptoKey].
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface CreateCryptoKeyRequestOrBuilder
      Returns:
      The bytes for parent.

    • setParent

      public CreateCryptoKeyRequest.Builder setParent(String value)
       Required. The [name][google.cloud.kms.v1.KeyRing.name] of the KeyRing
 associated with the [CryptoKeys][google.cloud.kms.v1.CryptoKey].
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      public CreateCryptoKeyRequest.Builder clearParent()
       Required. The [name][google.cloud.kms.v1.KeyRing.name] of the KeyRing
 associated with the [CryptoKeys][google.cloud.kms.v1.CryptoKey].
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setParentBytes

      public CreateCryptoKeyRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       Required. The [name][google.cloud.kms.v1.KeyRing.name] of the KeyRing
 associated with the [CryptoKeys][google.cloud.kms.v1.CryptoKey].
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • getCryptoKeyId

      public String getCryptoKeyId()
       Required. It must be unique within a KeyRing and match the regular
 expression `[a-zA-Z0-9_-]{1,63}`
      string crypto_key_id = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCryptoKeyId in interface CreateCryptoKeyRequestOrBuilder
      Returns:
      The cryptoKeyId.

    • getCryptoKeyIdBytes

      public com.google.protobuf.ByteString getCryptoKeyIdBytes()
       Required. It must be unique within a KeyRing and match the regular
 expression `[a-zA-Z0-9_-]{1,63}`
      string crypto_key_id = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCryptoKeyIdBytes in interface CreateCryptoKeyRequestOrBuilder
      Returns:
      The bytes for cryptoKeyId.

    • setCryptoKeyId

      public CreateCryptoKeyRequest.Builder setCryptoKeyId(String value)
       Required. It must be unique within a KeyRing and match the regular
 expression `[a-zA-Z0-9_-]{1,63}`
      string crypto_key_id = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The cryptoKeyId to set.
      Returns:
      This builder for chaining.

    • clearCryptoKeyId

      public CreateCryptoKeyRequest.Builder clearCryptoKeyId()
       Required. It must be unique within a KeyRing and match the regular
 expression `[a-zA-Z0-9_-]{1,63}`
      string crypto_key_id = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setCryptoKeyIdBytes

      public CreateCryptoKeyRequest.Builder setCryptoKeyIdBytes(com.google.protobuf.ByteString value)
       Required. It must be unique within a KeyRing and match the regular
 expression `[a-zA-Z0-9_-]{1,63}`
      string crypto_key_id = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for cryptoKeyId to set.
      Returns:
      This builder for chaining.

    • hasCryptoKey

      public boolean hasCryptoKey()
       Required. A [CryptoKey][google.cloud.kms.v1.CryptoKey] with initial field
 values.
      .google.cloud.kms.v1.CryptoKey crypto_key = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasCryptoKey in interface CreateCryptoKeyRequestOrBuilder
      Returns:
      Whether the cryptoKey field is set.

    • getCryptoKey

      public CryptoKey getCryptoKey()
       Required. A [CryptoKey][google.cloud.kms.v1.CryptoKey] with initial field
 values.
      .google.cloud.kms.v1.CryptoKey crypto_key = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCryptoKey in interface CreateCryptoKeyRequestOrBuilder
      Returns:
      The cryptoKey.

    • setCryptoKey

      public CreateCryptoKeyRequest.Builder setCryptoKey(CryptoKey value)
       Required. A [CryptoKey][google.cloud.kms.v1.CryptoKey] with initial field
 values.
      .google.cloud.kms.v1.CryptoKey crypto_key = 3 [(.google.api.field_behavior) = REQUIRED];

    • setCryptoKey

      public CreateCryptoKeyRequest.Builder setCryptoKey(CryptoKey.Builder builderForValue)
       Required. A [CryptoKey][google.cloud.kms.v1.CryptoKey] with initial field
 values.
      .google.cloud.kms.v1.CryptoKey crypto_key = 3 [(.google.api.field_behavior) = REQUIRED];

    • mergeCryptoKey

      public CreateCryptoKeyRequest.Builder mergeCryptoKey(CryptoKey value)
       Required. A [CryptoKey][google.cloud.kms.v1.CryptoKey] with initial field
 values.
      .google.cloud.kms.v1.CryptoKey crypto_key = 3 [(.google.api.field_behavior) = REQUIRED];

    • clearCryptoKey

      public CreateCryptoKeyRequest.Builder clearCryptoKey()
       Required. A [CryptoKey][google.cloud.kms.v1.CryptoKey] with initial field
 values.
      .google.cloud.kms.v1.CryptoKey crypto_key = 3 [(.google.api.field_behavior) = REQUIRED];

    • getCryptoKeyBuilder

      public CryptoKey.Builder getCryptoKeyBuilder()
       Required. A [CryptoKey][google.cloud.kms.v1.CryptoKey] with initial field
 values.
      .google.cloud.kms.v1.CryptoKey crypto_key = 3 [(.google.api.field_behavior) = REQUIRED];

    • getCryptoKeyOrBuilder

      public CryptoKeyOrBuilder getCryptoKeyOrBuilder()
       Required. A [CryptoKey][google.cloud.kms.v1.CryptoKey] with initial field
 values.
      .google.cloud.kms.v1.CryptoKey crypto_key = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCryptoKeyOrBuilder in interface CreateCryptoKeyRequestOrBuilder

    • getSkipInitialVersionCreation

      public boolean getSkipInitialVersionCreation()
       If set to true, the request will create a
 [CryptoKey][google.cloud.kms.v1.CryptoKey] without any
 [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion]. You must
 manually call
 [CreateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion]
 or
 [ImportCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.ImportCryptoKeyVersion]
 before you can use this [CryptoKey][google.cloud.kms.v1.CryptoKey].
      bool skip_initial_version_creation = 5;
      Specified by:
      getSkipInitialVersionCreation in interface CreateCryptoKeyRequestOrBuilder
      Returns:
      The skipInitialVersionCreation.

    • setSkipInitialVersionCreation

      public CreateCryptoKeyRequest.Builder setSkipInitialVersionCreation(boolean value)
       If set to true, the request will create a
 [CryptoKey][google.cloud.kms.v1.CryptoKey] without any
 [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion]. You must
 manually call
 [CreateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion]
 or
 [ImportCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.ImportCryptoKeyVersion]
 before you can use this [CryptoKey][google.cloud.kms.v1.CryptoKey].
      bool skip_initial_version_creation = 5;
      Parameters:
      value - The skipInitialVersionCreation to set.
      Returns:
      This builder for chaining.

    • clearSkipInitialVersionCreation

      public CreateCryptoKeyRequest.Builder clearSkipInitialVersionCreation()
       If set to true, the request will create a
 [CryptoKey][google.cloud.kms.v1.CryptoKey] without any
 [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion]. You must
 manually call
 [CreateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion]
 or
 [ImportCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.ImportCryptoKeyVersion]
 before you can use this [CryptoKey][google.cloud.kms.v1.CryptoKey].
      bool skip_initial_version_creation = 5;
      Returns:
      This builder for chaining.

    • getTrustedWrappingEnabled

      public boolean getTrustedWrappingEnabled()
       Optional. Whether trusted wrapping will be enabled on the first
 [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] created for this
 [CryptoKey][google.cloud.kms.v1.CryptoKey]. This field is only supported
 for keys with
 [CryptoKeyVersionTemplate.protection_level][google.cloud.kms.v1.CryptoKeyVersionTemplate.protection_level]
 [HSM_SINGLE_TENANT][google.cloud.kms.v1.ProtectionLevel.HSM_SINGLE_TENANT].
 This field is supported for all
 [CryptoKeyPurposes][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose] except
 [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT].
      bool trusted_wrapping_enabled = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTrustedWrappingEnabled in interface CreateCryptoKeyRequestOrBuilder
      Returns:
      The trustedWrappingEnabled.

    • setTrustedWrappingEnabled

      public CreateCryptoKeyRequest.Builder setTrustedWrappingEnabled(boolean value)
       Optional. Whether trusted wrapping will be enabled on the first
 [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] created for this
 [CryptoKey][google.cloud.kms.v1.CryptoKey]. This field is only supported
 for keys with
 [CryptoKeyVersionTemplate.protection_level][google.cloud.kms.v1.CryptoKeyVersionTemplate.protection_level]
 [HSM_SINGLE_TENANT][google.cloud.kms.v1.ProtectionLevel.HSM_SINGLE_TENANT].
 This field is supported for all
 [CryptoKeyPurposes][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose] except
 [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT].
      bool trusted_wrapping_enabled = 6 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The trustedWrappingEnabled to set.
      Returns:
      This builder for chaining.

    • clearTrustedWrappingEnabled

      public CreateCryptoKeyRequest.Builder clearTrustedWrappingEnabled()
       Optional. Whether trusted wrapping will be enabled on the first
 [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] created for this
 [CryptoKey][google.cloud.kms.v1.CryptoKey]. This field is only supported
 for keys with
 [CryptoKeyVersionTemplate.protection_level][google.cloud.kms.v1.CryptoKeyVersionTemplate.protection_level]
 [HSM_SINGLE_TENANT][google.cloud.kms.v1.ProtectionLevel.HSM_SINGLE_TENANT].
 This field is supported for all
 [CryptoKeyPurposes][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose] except
 [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT].
      bool trusted_wrapping_enabled = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.