Class PublicKey

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.kms.v1.PublicKey
All Implemented Interfaces:
PublicKeyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class PublicKey extends com.google.protobuf.GeneratedMessage implements PublicKeyOrBuilder
 The public keys for a given
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]. Obtained via
 [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
 
Protobuf type google.cloud.kms.v1.PublicKey
See Also:
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    The public keys for a given [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].
    static enum 
    The supported [PublicKey][google.cloud.kms.v1.PublicKey] formats.

    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
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     

    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
     
    The [Algorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm] associated with this key.
    int
    The [Algorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm] associated with this key.
    static PublicKey
     
     
    static final com.google.protobuf.Descriptors.Descriptor
     
    The [name][google.cloud.kms.v1.CryptoKeyVersion.name] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key.
    com.google.protobuf.ByteString
    The [name][google.cloud.kms.v1.CryptoKeyVersion.name] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key.
    com.google.protobuf.Parser<PublicKey>
     
    The public key, encoded in PEM format.
    com.google.protobuf.ByteString
    The public key, encoded in PEM format.
    com.google.protobuf.Int64Value
    Integrity verification field.
    com.google.protobuf.Int64ValueOrBuilder
    Integrity verification field.
    The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key.
    int
    The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key.
    This field contains the public key (with integrity verification), formatted according to the [public_key_format][google.cloud.kms.v1.PublicKey.public_key_format] field.
    The [PublicKey][google.cloud.kms.v1.PublicKey] format specified by the customer through the [public_key_format][google.cloud.kms.v1.GetPublicKeyRequest.public_key_format] field.
    int
    The [PublicKey][google.cloud.kms.v1.PublicKey] format specified by the customer through the [public_key_format][google.cloud.kms.v1.GetPublicKeyRequest.public_key_format] field.
    This field contains the public key (with integrity verification), formatted according to the [public_key_format][google.cloud.kms.v1.PublicKey.public_key_format] field.
    int
     
    int
     
    boolean
    Integrity verification field.
    boolean
    This field contains the public key (with integrity verification), formatted according to the [public_key_format][google.cloud.kms.v1.PublicKey.public_key_format] field.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
     
    final boolean
     
     
    newBuilder(PublicKey prototype)
     
     
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static PublicKey
     
    static PublicKey
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PublicKey
    parseFrom(byte[] data)
     
    static PublicKey
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PublicKey
    parseFrom(com.google.protobuf.ByteString data)
     
    static PublicKey
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PublicKey
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static PublicKey
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PublicKey
     
    static PublicKey
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PublicKey
     
    static PublicKey
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<PublicKey>
     
     
    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

    • PEM_FIELD_NUMBER

      public static final int PEM_FIELD_NUMBER
      See Also:
    • ALGORITHM_FIELD_NUMBER

      public static final int ALGORITHM_FIELD_NUMBER
      See Also:
    • PEM_CRC32C_FIELD_NUMBER

      public static final int PEM_CRC32C_FIELD_NUMBER
      See Also:
    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:
    • PROTECTION_LEVEL_FIELD_NUMBER

      public static final int PROTECTION_LEVEL_FIELD_NUMBER
      See Also:
    • PUBLIC_KEY_FORMAT_FIELD_NUMBER

      public static final int PUBLIC_KEY_FORMAT_FIELD_NUMBER
      See Also:
    • PUBLIC_KEY_FIELD_NUMBER

      public static final int PUBLIC_KEY_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
    • getPem

      public String getPem()
       The public key, encoded in PEM format. For more information, see the
       [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for
       [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and
       [Textual Encoding of Subject Public Key Info]
       (https://tools.ietf.org/html/rfc7468#section-13).
       
      string pem = 1;
      Specified by:
      getPem in interface PublicKeyOrBuilder
      Returns:
      The pem.
    • getPemBytes

      public com.google.protobuf.ByteString getPemBytes()
       The public key, encoded in PEM format. For more information, see the
       [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for
       [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and
       [Textual Encoding of Subject Public Key Info]
       (https://tools.ietf.org/html/rfc7468#section-13).
       
      string pem = 1;
      Specified by:
      getPemBytes in interface PublicKeyOrBuilder
      Returns:
      The bytes for pem.
    • getAlgorithmValue

      public int getAlgorithmValue()
       The
       [Algorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm]
       associated with this key.
       
      .google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 2;
      Specified by:
      getAlgorithmValue in interface PublicKeyOrBuilder
      Returns:
      The enum numeric value on the wire for algorithm.
    • getAlgorithm

       The
       [Algorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm]
       associated with this key.
       
      .google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 2;
      Specified by:
      getAlgorithm in interface PublicKeyOrBuilder
      Returns:
      The algorithm.
    • hasPemCrc32C

      public boolean hasPemCrc32C()
       Integrity verification field. A CRC32C checksum of the returned
       [PublicKey.pem][google.cloud.kms.v1.PublicKey.pem]. An integrity check of
       [PublicKey.pem][google.cloud.kms.v1.PublicKey.pem] can be performed by
       computing the CRC32C checksum of
       [PublicKey.pem][google.cloud.kms.v1.PublicKey.pem] and comparing your
       results to this field. Discard the response in case of non-matching
       checksum values, and perform a limited number of retries. A persistent
       mismatch may indicate an issue in your computation of the CRC32C checksum.
       Note: This field is defined as int64 for reasons of compatibility across
       different languages. However, it is a non-negative integer, which will
       never exceed `2^32-1`, and can be safely downconverted to uint32 in
       languages that support this type.
      
       NOTE: This field is in Beta.
       
      .google.protobuf.Int64Value pem_crc32c = 3;
      Specified by:
      hasPemCrc32C in interface PublicKeyOrBuilder
      Returns:
      Whether the pemCrc32c field is set.
    • getPemCrc32C

      public com.google.protobuf.Int64Value getPemCrc32C()
       Integrity verification field. A CRC32C checksum of the returned
       [PublicKey.pem][google.cloud.kms.v1.PublicKey.pem]. An integrity check of
       [PublicKey.pem][google.cloud.kms.v1.PublicKey.pem] can be performed by
       computing the CRC32C checksum of
       [PublicKey.pem][google.cloud.kms.v1.PublicKey.pem] and comparing your
       results to this field. Discard the response in case of non-matching
       checksum values, and perform a limited number of retries. A persistent
       mismatch may indicate an issue in your computation of the CRC32C checksum.
       Note: This field is defined as int64 for reasons of compatibility across
       different languages. However, it is a non-negative integer, which will
       never exceed `2^32-1`, and can be safely downconverted to uint32 in
       languages that support this type.
      
       NOTE: This field is in Beta.
       
      .google.protobuf.Int64Value pem_crc32c = 3;
      Specified by:
      getPemCrc32C in interface PublicKeyOrBuilder
      Returns:
      The pemCrc32c.
    • getPemCrc32COrBuilder

      public com.google.protobuf.Int64ValueOrBuilder getPemCrc32COrBuilder()
       Integrity verification field. A CRC32C checksum of the returned
       [PublicKey.pem][google.cloud.kms.v1.PublicKey.pem]. An integrity check of
       [PublicKey.pem][google.cloud.kms.v1.PublicKey.pem] can be performed by
       computing the CRC32C checksum of
       [PublicKey.pem][google.cloud.kms.v1.PublicKey.pem] and comparing your
       results to this field. Discard the response in case of non-matching
       checksum values, and perform a limited number of retries. A persistent
       mismatch may indicate an issue in your computation of the CRC32C checksum.
       Note: This field is defined as int64 for reasons of compatibility across
       different languages. However, it is a non-negative integer, which will
       never exceed `2^32-1`, and can be safely downconverted to uint32 in
       languages that support this type.
      
       NOTE: This field is in Beta.
       
      .google.protobuf.Int64Value pem_crc32c = 3;
      Specified by:
      getPemCrc32COrBuilder in interface PublicKeyOrBuilder
    • getName

      public String getName()
       The [name][google.cloud.kms.v1.CryptoKeyVersion.name] of the
       [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key.
       Provided here for verification.
      
       NOTE: This field is in Beta.
       
      string name = 4;
      Specified by:
      getName in interface PublicKeyOrBuilder
      Returns:
      The name.
    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The [name][google.cloud.kms.v1.CryptoKeyVersion.name] of the
       [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key.
       Provided here for verification.
      
       NOTE: This field is in Beta.
       
      string name = 4;
      Specified by:
      getNameBytes in interface PublicKeyOrBuilder
      Returns:
      The bytes for name.
    • getProtectionLevelValue

      public int getProtectionLevelValue()
       The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the
       [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key.
       
      .google.cloud.kms.v1.ProtectionLevel protection_level = 5;
      Specified by:
      getProtectionLevelValue in interface PublicKeyOrBuilder
      Returns:
      The enum numeric value on the wire for protectionLevel.
    • getProtectionLevel

      public ProtectionLevel getProtectionLevel()
       The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the
       [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key.
       
      .google.cloud.kms.v1.ProtectionLevel protection_level = 5;
      Specified by:
      getProtectionLevel in interface PublicKeyOrBuilder
      Returns:
      The protectionLevel.
    • getPublicKeyFormatValue

      public int getPublicKeyFormatValue()
       The [PublicKey][google.cloud.kms.v1.PublicKey] format specified by the
       customer through the
       [public_key_format][google.cloud.kms.v1.GetPublicKeyRequest.public_key_format]
       field.
       
      .google.cloud.kms.v1.PublicKey.PublicKeyFormat public_key_format = 7;
      Specified by:
      getPublicKeyFormatValue in interface PublicKeyOrBuilder
      Returns:
      The enum numeric value on the wire for publicKeyFormat.
    • getPublicKeyFormat

      public PublicKey.PublicKeyFormat getPublicKeyFormat()
       The [PublicKey][google.cloud.kms.v1.PublicKey] format specified by the
       customer through the
       [public_key_format][google.cloud.kms.v1.GetPublicKeyRequest.public_key_format]
       field.
       
      .google.cloud.kms.v1.PublicKey.PublicKeyFormat public_key_format = 7;
      Specified by:
      getPublicKeyFormat in interface PublicKeyOrBuilder
      Returns:
      The publicKeyFormat.
    • hasPublicKey

      public boolean hasPublicKey()
       This field contains the public key (with integrity verification), formatted
       according to the
       [public_key_format][google.cloud.kms.v1.PublicKey.public_key_format] field.
       
      .google.cloud.kms.v1.ChecksummedData public_key = 8;
      Specified by:
      hasPublicKey in interface PublicKeyOrBuilder
      Returns:
      Whether the publicKey field is set.
    • getPublicKey

      public ChecksummedData getPublicKey()
       This field contains the public key (with integrity verification), formatted
       according to the
       [public_key_format][google.cloud.kms.v1.PublicKey.public_key_format] field.
       
      .google.cloud.kms.v1.ChecksummedData public_key = 8;
      Specified by:
      getPublicKey in interface PublicKeyOrBuilder
      Returns:
      The publicKey.
    • getPublicKeyOrBuilder

      public ChecksummedDataOrBuilder getPublicKeyOrBuilder()
       This field contains the public key (with integrity verification), formatted
       according to the
       [public_key_format][google.cloud.kms.v1.PublicKey.public_key_format] field.
       
      .google.cloud.kms.v1.ChecksummedData public_key = 8;
      Specified by:
      getPublicKeyOrBuilder in interface PublicKeyOrBuilder
    • 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 PublicKey parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

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

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

      public static PublicKey parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

      public static PublicKey parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

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

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

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

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

      public static PublicKey.Builder newBuilder()
    • newBuilder

      public static PublicKey.Builder newBuilder(PublicKey prototype)
    • toBuilder

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

      protected PublicKey.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static PublicKey getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<PublicKey> parser()
    • getParserForType

      public com.google.protobuf.Parser<PublicKey> 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 PublicKey getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder