Package com.google.cloud.kms.v1

Interface CreateCryptoKeyRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    CryptoKey
    getCryptoKey()
    Required.
    String
    getCryptoKeyId()
    Required.
    com.google.protobuf.ByteString
    getCryptoKeyIdBytes()
    Required.
    CryptoKeyOrBuilder
    getCryptoKeyOrBuilder()
    Required.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    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].
    boolean
    getTrustedWrappingEnabled()
    Optional.
    boolean
    hasCryptoKey()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getParent

      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) = { ... }
      Returns:
      The parent.

    • getParentBytes

      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) = { ... }
      Returns:
      The bytes for parent.

    • getCryptoKeyId

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

    • getCryptoKeyIdBytes

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

    • hasCryptoKey

      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];
      Returns:
      Whether the cryptoKey field is set.

    • getCryptoKey

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

    • getCryptoKeyOrBuilder

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

    • getSkipInitialVersionCreation

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

    • getTrustedWrappingEnabled

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