Class PublicKey (2.73.0) 

public final class PublicKey extends GeneratedMessageV3 implements PublicKeyOrBuilder

The public keys for a given CryptoKeyVersion. Obtained via GetPublicKey.

Protobuf type google.cloud.kms.v1.PublicKey

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PublicKey

Implements

PublicKeyOrBuilder

Static Fields

ALGORITHM_FIELD_NUMBER

public static final int ALGORITHM_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PEM_CRC32C_FIELD_NUMBER

public static final int PEM_CRC32C_FIELD_NUMBER
Field Value
Type Description
int

PEM_FIELD_NUMBER

public static final int PEM_FIELD_NUMBER
Field Value
Type Description
int

PROTECTION_LEVEL_FIELD_NUMBER

public static final int PROTECTION_LEVEL_FIELD_NUMBER
Field Value
Type Description
int

PUBLIC_KEY_FIELD_NUMBER

public static final int PUBLIC_KEY_FIELD_NUMBER
Field Value
Type Description
int

PUBLIC_KEY_FORMAT_FIELD_NUMBER

public static final int PUBLIC_KEY_FORMAT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PublicKey getDefaultInstance()
Returns
Type Description
PublicKey

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PublicKey.Builder newBuilder()
Returns
Type Description
PublicKey.Builder

newBuilder(PublicKey prototype)

public static PublicKey.Builder newBuilder(PublicKey prototype)
Parameter
Name Description
prototype PublicKey
Returns
Type Description
PublicKey.Builder

parseDelimitedFrom(InputStream input)

public static PublicKey parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PublicKey
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PublicKey parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublicKey
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PublicKey parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PublicKey
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PublicKey parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublicKey
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PublicKey parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PublicKey
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PublicKey parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublicKey
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PublicKey parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PublicKey
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PublicKey parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublicKey
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PublicKey parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PublicKey
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PublicKey parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublicKey
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PublicKey parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PublicKey
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PublicKey parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublicKey
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PublicKey> parser()
Returns
Type Description
Parser<PublicKey>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAlgorithm()

public CryptoKeyVersion.CryptoKeyVersionAlgorithm getAlgorithm()

The Algorithm associated with this key.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 2;

Returns
Type Description
CryptoKeyVersion.CryptoKeyVersionAlgorithm

The algorithm.

getAlgorithmValue()

public int getAlgorithmValue()

The Algorithm associated with this key.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 2;

Returns
Type Description
int

The enum numeric value on the wire for algorithm.

getDefaultInstanceForType()

public PublicKey getDefaultInstanceForType()
Returns
Type Description
PublicKey

getName()

public String getName()

The name of the CryptoKeyVersion public key. Provided here for verification.

NOTE: This field is in Beta.

string name = 4;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of the CryptoKeyVersion public key. Provided here for verification.

NOTE: This field is in Beta.

string name = 4;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<PublicKey> getParserForType()
Returns
Type Description
Parser<PublicKey>
Overrides

getPem()

public String getPem()

The public key, encoded in PEM format. For more information, see the RFC 7468 sections for General Considerations and Textual Encoding of Subject Public Key Info.

string pem = 1;

Returns
Type Description
String

The pem.

getPemBytes()

public ByteString getPemBytes()

The public key, encoded in PEM format. For more information, see the RFC 7468 sections for General Considerations and Textual Encoding of Subject Public Key Info.

string pem = 1;

Returns
Type Description
ByteString

The bytes for pem.

getPemCrc32C()

public Int64Value getPemCrc32C()

Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of 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;

Returns
Type Description
Int64Value

The pemCrc32c.

getPemCrc32COrBuilder()

public Int64ValueOrBuilder getPemCrc32COrBuilder()

Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of 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;

Returns
Type Description
Int64ValueOrBuilder

getProtectionLevel()

public ProtectionLevel getProtectionLevel()

The ProtectionLevel of the CryptoKeyVersion public key.

.google.cloud.kms.v1.ProtectionLevel protection_level = 5;

Returns
Type Description
ProtectionLevel

The protectionLevel.

getProtectionLevelValue()

public int getProtectionLevelValue()

The ProtectionLevel of the CryptoKeyVersion public key.

.google.cloud.kms.v1.ProtectionLevel protection_level = 5;

Returns
Type Description
int

The enum numeric value on the wire for protectionLevel.

getPublicKey()

public ChecksummedData getPublicKey()

This field contains the public key (with integrity verification), formatted according to the public_key_format field.

.google.cloud.kms.v1.ChecksummedData public_key = 8;

Returns
Type Description
ChecksummedData

The publicKey.

getPublicKeyFormat()

public PublicKey.PublicKeyFormat getPublicKeyFormat()

The PublicKey format specified by the customer through the public_key_format field.

.google.cloud.kms.v1.PublicKey.PublicKeyFormat public_key_format = 7;

Returns
Type Description
PublicKey.PublicKeyFormat

The publicKeyFormat.

getPublicKeyFormatValue()

public int getPublicKeyFormatValue()

The PublicKey format specified by the customer through the public_key_format field.

.google.cloud.kms.v1.PublicKey.PublicKeyFormat public_key_format = 7;

Returns
Type Description
int

The enum numeric value on the wire for publicKeyFormat.

getPublicKeyOrBuilder()

public ChecksummedDataOrBuilder getPublicKeyOrBuilder()

This field contains the public key (with integrity verification), formatted according to the public_key_format field.

.google.cloud.kms.v1.ChecksummedData public_key = 8;

Returns
Type Description
ChecksummedDataOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasPemCrc32C()

public boolean hasPemCrc32C()

Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of 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;

Returns
Type Description
boolean

Whether the pemCrc32c field is set.

hasPublicKey()

public boolean hasPublicKey()

This field contains the public key (with integrity verification), formatted according to the public_key_format field.

.google.cloud.kms.v1.ChecksummedData public_key = 8;

Returns
Type Description
boolean

Whether the publicKey field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PublicKey.Builder newBuilderForType()
Returns
Type Description
PublicKey.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PublicKey.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PublicKey.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PublicKey.Builder toBuilder()
Returns
Type Description
PublicKey.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException