Class CryptoKeyVersionTemplate

  • All Implemented Interfaces:
    CryptoKeyVersionTemplateOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class CryptoKeyVersionTemplate
    extends com.google.protobuf.GeneratedMessageV3
    implements CryptoKeyVersionTemplateOrBuilder
     A [CryptoKeyVersionTemplate][google.cloud.kms.v1.CryptoKeyVersionTemplate]
     specifies the properties to use when creating a new
     [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion], either manually
     with
     [CreateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion]
     or automatically as a result of auto-rotation.
     
    Protobuf type google.cloud.kms.v1.CryptoKeyVersionTemplate
    See Also:
    Serialized Form
    • Field Detail

      • PROTECTION_LEVEL_FIELD_NUMBER

        public static final int PROTECTION_LEVEL_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getProtectionLevelValue

        public int getProtectionLevelValue()
         [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] to use when creating
         a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] based on this
         template. Immutable. Defaults to
         [SOFTWARE][google.cloud.kms.v1.ProtectionLevel.SOFTWARE].
         
        .google.cloud.kms.v1.ProtectionLevel protection_level = 1;
        Specified by:
        getProtectionLevelValue in interface CryptoKeyVersionTemplateOrBuilder
        Returns:
        The enum numeric value on the wire for protectionLevel.
      • getProtectionLevel

        public ProtectionLevel getProtectionLevel()
         [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] to use when creating
         a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] based on this
         template. Immutable. Defaults to
         [SOFTWARE][google.cloud.kms.v1.ProtectionLevel.SOFTWARE].
         
        .google.cloud.kms.v1.ProtectionLevel protection_level = 1;
        Specified by:
        getProtectionLevel in interface CryptoKeyVersionTemplateOrBuilder
        Returns:
        The protectionLevel.
      • getAlgorithmValue

        public int getAlgorithmValue()
         Required.
         [Algorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm]
         to use when creating a
         [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] based on this
         template.
        
         For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is implied if both
         this field is omitted and
         [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] is
         [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT].
         
        .google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getAlgorithmValue in interface CryptoKeyVersionTemplateOrBuilder
        Returns:
        The enum numeric value on the wire for algorithm.
      • getAlgorithm

        public CryptoKeyVersion.CryptoKeyVersionAlgorithm getAlgorithm()
         Required.
         [Algorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm]
         to use when creating a
         [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] based on this
         template.
        
         For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is implied if both
         this field is omitted and
         [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] is
         [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT].
         
        .google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getAlgorithm in interface CryptoKeyVersionTemplateOrBuilder
        Returns:
        The algorithm.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static CryptoKeyVersionTemplate parseFrom​(ByteBuffer data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static CryptoKeyVersionTemplate parseFrom​(ByteBuffer data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static CryptoKeyVersionTemplate parseFrom​(com.google.protobuf.ByteString data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static CryptoKeyVersionTemplate parseFrom​(com.google.protobuf.ByteString data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static CryptoKeyVersionTemplate parseFrom​(byte[] data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static CryptoKeyVersionTemplate parseFrom​(byte[] data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • newBuilderForType

        public CryptoKeyVersionTemplate.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public CryptoKeyVersionTemplate.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected CryptoKeyVersionTemplate.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<CryptoKeyVersionTemplate> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

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