Class DecapsulateRequest (2.77.0)

public final class DecapsulateRequest extends GeneratedMessageV3 implements DecapsulateRequestOrBuilder

Request message for KeyManagementService.Decapsulate.

Protobuf type google.cloud.kms.v1.DecapsulateRequest

Static Fields

CIPHERTEXT_CRC32C_FIELD_NUMBER

public static final int CIPHERTEXT_CRC32C_FIELD_NUMBER
Field Value
Type Description
int

CIPHERTEXT_FIELD_NUMBER

public static final int CIPHERTEXT_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DecapsulateRequest getDefaultInstance()
Returns
Type Description
DecapsulateRequest

getDescriptor()

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

newBuilder()

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

newBuilder(DecapsulateRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCiphertext()

public ByteString getCiphertext()

Required. The ciphertext produced from encapsulation with the named CryptoKeyVersion public key(s).

bytes ciphertext = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The ciphertext.

getCiphertextCrc32C()

public Int64Value getCiphertextCrc32C()

Optional. A CRC32C checksum of the DecapsulateRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received DecapsulateRequest.ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(DecapsulateRequest.ciphertext) is equal to DecapsulateRequest.ciphertext_crc32c, and if so, 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.

.google.protobuf.Int64Value ciphertext_crc32c = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Int64Value

The ciphertextCrc32c.

getCiphertextCrc32COrBuilder()

public Int64ValueOrBuilder getCiphertextCrc32COrBuilder()

Optional. A CRC32C checksum of the DecapsulateRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received DecapsulateRequest.ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(DecapsulateRequest.ciphertext) is equal to DecapsulateRequest.ciphertext_crc32c, and if so, 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.

.google.protobuf.Int64Value ciphertext_crc32c = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Int64ValueOrBuilder

getDefaultInstanceForType()

public DecapsulateRequest getDefaultInstanceForType()
Returns
Type Description
DecapsulateRequest

getName()

public String getName()

Required. The resource name of the CryptoKeyVersion to use for decapsulation.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The resource name of the CryptoKeyVersion to use for decapsulation.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasCiphertextCrc32C()

public boolean hasCiphertextCrc32C()

Optional. A CRC32C checksum of the DecapsulateRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received DecapsulateRequest.ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(DecapsulateRequest.ciphertext) is equal to DecapsulateRequest.ciphertext_crc32c, and if so, 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.

.google.protobuf.Int64Value ciphertext_crc32c = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the ciphertextCrc32c 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 DecapsulateRequest.Builder newBuilderForType()
Returns
Type Description
DecapsulateRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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