Package com.google.cloud.kms.v1

Enum EkmConnection.KeyManagementMode

java.lang.Object
java.lang.Enum<EkmConnection.KeyManagementMode>
com.google.cloud.kms.v1.EkmConnection.KeyManagementMode
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<EkmConnection.KeyManagementMode>
Enclosing class:
EkmConnection
public static enum EkmConnection.KeyManagementMode extends Enum<EkmConnection.KeyManagementMode> implements com.google.protobuf.ProtocolMessageEnum
 [KeyManagementMode][google.cloud.kms.v1.EkmConnection.KeyManagementMode]
 describes who can perform control plane cryptographic operations using this
 [EkmConnection][google.cloud.kms.v1.EkmConnection].
Protobuf enum google.cloud.kms.v1.EkmConnection.KeyManagementMode

  • Enum Constant Details

    • KEY_MANAGEMENT_MODE_UNSPECIFIED

      public static final EkmConnection.KeyManagementMode KEY_MANAGEMENT_MODE_UNSPECIFIED
       Not specified.
      KEY_MANAGEMENT_MODE_UNSPECIFIED = 0;

    • MANUAL

      public static final EkmConnection.KeyManagementMode MANUAL
       EKM-side key management operations on
 [CryptoKeys][google.cloud.kms.v1.CryptoKey] created with this
 [EkmConnection][google.cloud.kms.v1.EkmConnection] must be initiated from
 the EKM directly and cannot be performed from Cloud KMS. This means that:
 * When creating a
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] associated with
 this
 [EkmConnection][google.cloud.kms.v1.EkmConnection], the caller must
 supply the key path of pre-existing external key material that will be
 linked to the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].
 * Destruction of external key material cannot be requested via the
 Cloud KMS API and must be performed directly in the EKM.
 * Automatic rotation of key material is not supported.
      MANUAL = 1;

    • CLOUD_KMS

      public static final EkmConnection.KeyManagementMode CLOUD_KMS
       All [CryptoKeys][google.cloud.kms.v1.CryptoKey] created with this
 [EkmConnection][google.cloud.kms.v1.EkmConnection] use EKM-side key
 management operations initiated from Cloud KMS. This means that:

 * When a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]
 associated with this [EkmConnection][google.cloud.kms.v1.EkmConnection]
 is
 created, the EKM automatically generates new key material and a new
 key path. The caller cannot supply the key path of pre-existing
 external key material.
 * Destruction of external key material associated with this
 [EkmConnection][google.cloud.kms.v1.EkmConnection] can be requested by
 calling
 [DestroyCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.DestroyCryptoKeyVersion].
 * Automatic rotation of key material is supported.
      CLOUD_KMS = 2;

    • UNRECOGNIZED

      public static final EkmConnection.KeyManagementMode UNRECOGNIZED

  • Field Details

    • KEY_MANAGEMENT_MODE_UNSPECIFIED_VALUE

      public static final int KEY_MANAGEMENT_MODE_UNSPECIFIED_VALUE
       Not specified.
      KEY_MANAGEMENT_MODE_UNSPECIFIED = 0;
      See Also:

    • MANUAL_VALUE

      public static final int MANUAL_VALUE
       EKM-side key management operations on
 [CryptoKeys][google.cloud.kms.v1.CryptoKey] created with this
 [EkmConnection][google.cloud.kms.v1.EkmConnection] must be initiated from
 the EKM directly and cannot be performed from Cloud KMS. This means that:
 * When creating a
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] associated with
 this
 [EkmConnection][google.cloud.kms.v1.EkmConnection], the caller must
 supply the key path of pre-existing external key material that will be
 linked to the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].
 * Destruction of external key material cannot be requested via the
 Cloud KMS API and must be performed directly in the EKM.
 * Automatic rotation of key material is not supported.
      MANUAL = 1;
      See Also:

    • CLOUD_KMS_VALUE

      public static final int CLOUD_KMS_VALUE
       All [CryptoKeys][google.cloud.kms.v1.CryptoKey] created with this
 [EkmConnection][google.cloud.kms.v1.EkmConnection] use EKM-side key
 management operations initiated from Cloud KMS. This means that:

 * When a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]
 associated with this [EkmConnection][google.cloud.kms.v1.EkmConnection]
 is
 created, the EKM automatically generates new key material and a new
 key path. The caller cannot supply the key path of pre-existing
 external key material.
 * Destruction of external key material associated with this
 [EkmConnection][google.cloud.kms.v1.EkmConnection] can be requested by
 calling
 [DestroyCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.DestroyCryptoKeyVersion].
 * Automatic rotation of key material is supported.
      CLOUD_KMS = 2;
      See Also:

  • Method Details

    • values

      public static EkmConnection.KeyManagementMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static EkmConnection.KeyManagementMode valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static EkmConnection.KeyManagementMode valueOf(int value)
      Deprecated.
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static EkmConnection.KeyManagementMode forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<EkmConnection.KeyManagementMode> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static EkmConnection.KeyManagementMode valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null