com.google.cloud.kms.v1

Class PublicKey

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

public final class PublicKey
extends com.google.protobuf.GeneratedMessageV3
implements PublicKeyOrBuilder

 The public key 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PublicKey.Builder The public key for a given [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALGORITHM_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	PEM_CRC32C_FIELD_NUMBER
static int	PEM_FIELD_NUMBER
static int	PROTECTION_LEVEL_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, 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 and Description
boolean	equals(Object obj)
CryptoKeyVersion.CryptoKeyVersionAlgorithm	getAlgorithm() The [Algorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm] associated with this key.
int	getAlgorithmValue() The [Algorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm] associated with this key.
static PublicKey	getDefaultInstance()
PublicKey	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getName() The [name][google.cloud.kms.v1.CryptoKeyVersion.name] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key.
com.google.protobuf.ByteString	getNameBytes() The [name][google.cloud.kms.v1.CryptoKeyVersion.name] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key.
com.google.protobuf.Parser<PublicKey>	getParserForType()
String	getPem() The public key, encoded in PEM format.
com.google.protobuf.ByteString	getPemBytes() The public key, encoded in PEM format.
com.google.protobuf.Int64Value	getPemCrc32C() Integrity verification field.
com.google.protobuf.Int64ValueOrBuilder	getPemCrc32COrBuilder() Integrity verification field.
ProtectionLevel	getProtectionLevel() The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key.
int	getProtectionLevelValue() The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasPemCrc32C() Integrity verification field.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static PublicKey.Builder	newBuilder()
static PublicKey.Builder	newBuilder(PublicKey prototype)
PublicKey.Builder	newBuilderForType()
protected PublicKey.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static PublicKey	parseDelimitedFrom(InputStream input)
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(ByteBuffer data)
static PublicKey	parseFrom(ByteBuffer 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	parseFrom(InputStream input)
static PublicKey	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<PublicKey>	parser()
PublicKey.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PEM_FIELD_NUMBER

public static final int PEM_FIELD_NUMBER

See Also:

Constant Field Values

ALGORITHM_FIELD_NUMBER

public static final int ALGORITHM_FIELD_NUMBER

See Also:

Constant Field Values

PEM_CRC32C_FIELD_NUMBER

public static final int PEM_CRC32C_FIELD_NUMBER

See Also:

Constant Field Values

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

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

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields 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

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

public CryptoKeyVersion.CryptoKeyVersionAlgorithm 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.

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 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.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

getDefaultInstanceForType

public PublicKey getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder