Class CustomerEncryptionKey (2.25.0)

public final class CustomerEncryptionKey extends GeneratedMessageV3 implements CustomerEncryptionKeyOrBuilder

Customer's encryption key.

Protobuf type google.cloud.tpu.v2alpha1.CustomerEncryptionKey

Static Fields

KMS_KEY_NAME_FIELD_NUMBER

public static final int KMS_KEY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CustomerEncryptionKey getDefaultInstance()
Returns
TypeDescription
CustomerEncryptionKey

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CustomerEncryptionKey.Builder newBuilder()
Returns
TypeDescription
CustomerEncryptionKey.Builder

newBuilder(CustomerEncryptionKey prototype)

public static CustomerEncryptionKey.Builder newBuilder(CustomerEncryptionKey prototype)
Parameter
NameDescription
prototypeCustomerEncryptionKey
Returns
TypeDescription
CustomerEncryptionKey.Builder

parseDelimitedFrom(InputStream input)

public static CustomerEncryptionKey parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CustomerEncryptionKey
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomerEncryptionKey parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomerEncryptionKey
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CustomerEncryptionKey parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CustomerEncryptionKey
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CustomerEncryptionKey parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomerEncryptionKey
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CustomerEncryptionKey parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CustomerEncryptionKey
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CustomerEncryptionKey parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomerEncryptionKey
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CustomerEncryptionKey parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CustomerEncryptionKey
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomerEncryptionKey parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomerEncryptionKey
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CustomerEncryptionKey parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CustomerEncryptionKey
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomerEncryptionKey parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomerEncryptionKey
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CustomerEncryptionKey parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CustomerEncryptionKey
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CustomerEncryptionKey parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomerEncryptionKey
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CustomerEncryptionKey> parser()
Returns
TypeDescription
Parser<CustomerEncryptionKey>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public CustomerEncryptionKey getDefaultInstanceForType()
Returns
TypeDescription
CustomerEncryptionKey

getKeyCase()

public CustomerEncryptionKey.KeyCase getKeyCase()
Returns
TypeDescription
CustomerEncryptionKey.KeyCase

getKmsKeyName()

public String getKmsKeyName()

The name of the encryption key that is stored in Google Cloud KMS. For example: <pre class="lang-html">"kmsKeyName": "projects/ <var class="apiparam">kms_project_id</var>/locations/ <var class="apiparam">region</var>/keyRings/<var class="apiparam"> key_region</var>/cryptoKeys/<var class="apiparam">key</var> </pre> The fully-qualifed key name may be returned for resource GET requests. For example: <pre class="lang-html">"kmsKeyName": "projects/ <var class="apiparam">kms_project_id</var>/locations/ <var class="apiparam">region</var>/keyRings/<var class="apiparam"> key_region</var>/cryptoKeys/<var class="apiparam">key</var> /cryptoKeyVersions/1</pre>

string kms_key_name = 7;

Returns
TypeDescription
String

The kmsKeyName.

getKmsKeyNameBytes()

public ByteString getKmsKeyNameBytes()

The name of the encryption key that is stored in Google Cloud KMS. For example: <pre class="lang-html">"kmsKeyName": "projects/ <var class="apiparam">kms_project_id</var>/locations/ <var class="apiparam">region</var>/keyRings/<var class="apiparam"> key_region</var>/cryptoKeys/<var class="apiparam">key</var> </pre> The fully-qualifed key name may be returned for resource GET requests. For example: <pre class="lang-html">"kmsKeyName": "projects/ <var class="apiparam">kms_project_id</var>/locations/ <var class="apiparam">region</var>/keyRings/<var class="apiparam"> key_region</var>/cryptoKeys/<var class="apiparam">key</var> /cryptoKeyVersions/1</pre>

string kms_key_name = 7;

Returns
TypeDescription
ByteString

The bytes for kmsKeyName.

getParserForType()

public Parser<CustomerEncryptionKey> getParserForType()
Returns
TypeDescription
Parser<CustomerEncryptionKey>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasKmsKeyName()

public boolean hasKmsKeyName()

The name of the encryption key that is stored in Google Cloud KMS. For example: <pre class="lang-html">"kmsKeyName": "projects/ <var class="apiparam">kms_project_id</var>/locations/ <var class="apiparam">region</var>/keyRings/<var class="apiparam"> key_region</var>/cryptoKeys/<var class="apiparam">key</var> </pre> The fully-qualifed key name may be returned for resource GET requests. For example: <pre class="lang-html">"kmsKeyName": "projects/ <var class="apiparam">kms_project_id</var>/locations/ <var class="apiparam">region</var>/keyRings/<var class="apiparam"> key_region</var>/cryptoKeys/<var class="apiparam">key</var> /cryptoKeyVersions/1</pre>

string kms_key_name = 7;

Returns
TypeDescription
boolean

Whether the kmsKeyName field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CustomerEncryptionKey.Builder newBuilderForType()
Returns
TypeDescription
CustomerEncryptionKey.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CustomerEncryptionKey.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CustomerEncryptionKey.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CustomerEncryptionKey.Builder toBuilder()
Returns
TypeDescription
CustomerEncryptionKey.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException