Package com.google.cloud.kms.v1

Class CryptoKeyVersionTemplate

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.kms.v1.CryptoKeyVersionTemplate
All Implemented Interfaces:
CryptoKeyVersionTemplateOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class CryptoKeyVersionTemplate extends com.google.protobuf.GeneratedMessage 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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CryptoKeyVersionTemplate.Builder
    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.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ALGORITHM_FIELD_NUMBER
     
    static final int
    PROTECTION_LEVEL_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    CryptoKeyVersion.CryptoKeyVersionAlgorithm
    getAlgorithm()
    Required.
    int
    getAlgorithmValue()
    Required.
    static CryptoKeyVersionTemplate
    getDefaultInstance()
     
    CryptoKeyVersionTemplate
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<CryptoKeyVersionTemplate>
    getParserForType()
     
    ProtectionLevel
    getProtectionLevel()
    [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] to use when creating a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] based on this template.
    int
    getProtectionLevelValue()
    [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] to use when creating a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] based on this template.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static CryptoKeyVersionTemplate.Builder
    newBuilder()
     
    static CryptoKeyVersionTemplate.Builder
    newBuilder(CryptoKeyVersionTemplate prototype)
     
    CryptoKeyVersionTemplate.Builder
    newBuilderForType()
     
    protected CryptoKeyVersionTemplate.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static CryptoKeyVersionTemplate
    parseDelimitedFrom(InputStream input)
     
    static CryptoKeyVersionTemplate
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CryptoKeyVersionTemplate
    parseFrom(byte[] data)
     
    static CryptoKeyVersionTemplate
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CryptoKeyVersionTemplate
    parseFrom(com.google.protobuf.ByteString data)
     
    static CryptoKeyVersionTemplate
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CryptoKeyVersionTemplate
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static CryptoKeyVersionTemplate
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CryptoKeyVersionTemplate
    parseFrom(InputStream input)
     
    static CryptoKeyVersionTemplate
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CryptoKeyVersionTemplate
    parseFrom(ByteBuffer data)
     
    static CryptoKeyVersionTemplate
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<CryptoKeyVersionTemplate>
    parser()
     
    CryptoKeyVersionTemplate.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • PROTECTION_LEVEL_FIELD_NUMBER

      public static final int PROTECTION_LEVEL_FIELD_NUMBER
      See Also:

    • ALGORITHM_FIELD_NUMBER

      public static final int ALGORITHM_FIELD_NUMBER
      See Also:

  • 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

    • 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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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

    • parseFrom

      public static CryptoKeyVersionTemplate parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CryptoKeyVersionTemplate parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CryptoKeyVersionTemplate parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CryptoKeyVersionTemplate parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CryptoKeyVersionTemplate parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CryptoKeyVersionTemplate parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static CryptoKeyVersionTemplate.Builder newBuilder()

    • newBuilder

      public static CryptoKeyVersionTemplate.Builder newBuilder(CryptoKeyVersionTemplate prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static CryptoKeyVersionTemplate getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<CryptoKeyVersionTemplate> parser()

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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