public final class EncryptRequest extends GeneratedMessageV3 implements EncryptRequestOrBuilder
Request message for KeyManagementService.Encrypt.
Protobuf type google.cloud.kms.v1.EncryptRequest
Fields
ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER
public static final int ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER
Field Value
ADDITIONAL_AUTHENTICATED_DATA_FIELD_NUMBER
public static final int ADDITIONAL_AUTHENTICATED_DATA_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
PLAINTEXT_CRC32C_FIELD_NUMBER
public static final int PLAINTEXT_CRC32C_FIELD_NUMBER
Field Value
PLAINTEXT_FIELD_NUMBER
public static final int PLAINTEXT_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAdditionalAuthenticatedData()
public ByteString getAdditionalAuthenticatedData()
Optional. Optional data that, if specified, must also be provided during decryption
through DecryptRequest.additional_authenticated_data.
The maximum size depends on the key version's
protection_level. For
SOFTWARE keys, the AAD must be no larger than
64KiB. For HSM keys, the combined length of the
plaintext and additional_authenticated_data fields must be no larger than
8KiB.
bytes additional_authenticated_data = 3 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| ByteString | The additionalAuthenticatedData.
|
getAdditionalAuthenticatedDataCrc32C()
public Int64Value getAdditionalAuthenticatedDataCrc32C()
Optional. An optional CRC32C checksum of the
EncryptRequest.additional_authenticated_data. If specified,
KeyManagementService will verify the integrity of the received
EncryptRequest.additional_authenticated_data 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(EncryptRequest.additional_authenticated_data) is equal to
EncryptRequest.additional_authenticated_data_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 additional_authenticated_data_crc32c = 8 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| Int64Value | The additionalAuthenticatedDataCrc32c.
|
getAdditionalAuthenticatedDataCrc32COrBuilder()
public Int64ValueOrBuilder getAdditionalAuthenticatedDataCrc32COrBuilder()
Optional. An optional CRC32C checksum of the
EncryptRequest.additional_authenticated_data. If specified,
KeyManagementService will verify the integrity of the received
EncryptRequest.additional_authenticated_data 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(EncryptRequest.additional_authenticated_data) is equal to
EncryptRequest.additional_authenticated_data_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 additional_authenticated_data_crc32c = 8 [(.google.api.field_behavior) = OPTIONAL];
getDefaultInstance()
public static EncryptRequest getDefaultInstance()
Returns
getDefaultInstanceForType()
public EncryptRequest getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getName()
Required. The resource name of the CryptoKey or CryptoKeyVersion
to use for encryption.
If a CryptoKey is specified, the server will use its
primary version.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
| String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Required. The resource name of the CryptoKey or CryptoKeyVersion
to use for encryption.
If a CryptoKey is specified, the server will use its
primary version.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getParserForType()
public Parser<EncryptRequest> getParserForType()
Returns
Overrides
getPlaintext()
public ByteString getPlaintext()
Required. The data to encrypt. Must be no larger than 64KiB.
The maximum size depends on the key version's
protection_level. For
SOFTWARE keys, the plaintext must be no larger
than 64KiB. For HSM keys, the combined length of the
plaintext and additional_authenticated_data fields must be no larger than
8KiB.
bytes plaintext = 2 [(.google.api.field_behavior) = REQUIRED];
getPlaintextCrc32C()
public Int64Value getPlaintextCrc32C()
Optional. An optional CRC32C checksum of the EncryptRequest.plaintext. If
specified, KeyManagementService will verify the integrity of the
received EncryptRequest.plaintext 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(EncryptRequest.plaintext) is equal to
EncryptRequest.plaintext_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 plaintext_crc32c = 7 [(.google.api.field_behavior) = OPTIONAL];
getPlaintextCrc32COrBuilder()
public Int64ValueOrBuilder getPlaintextCrc32COrBuilder()
Optional. An optional CRC32C checksum of the EncryptRequest.plaintext. If
specified, KeyManagementService will verify the integrity of the
received EncryptRequest.plaintext 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(EncryptRequest.plaintext) is equal to
EncryptRequest.plaintext_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 plaintext_crc32c = 7 [(.google.api.field_behavior) = OPTIONAL];
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasAdditionalAuthenticatedDataCrc32C()
public boolean hasAdditionalAuthenticatedDataCrc32C()
Optional. An optional CRC32C checksum of the
EncryptRequest.additional_authenticated_data. If specified,
KeyManagementService will verify the integrity of the received
EncryptRequest.additional_authenticated_data 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(EncryptRequest.additional_authenticated_data) is equal to
EncryptRequest.additional_authenticated_data_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 additional_authenticated_data_crc32c = 8 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the additionalAuthenticatedDataCrc32c field is set.
|
hasPlaintextCrc32C()
public boolean hasPlaintextCrc32C()
Optional. An optional CRC32C checksum of the EncryptRequest.plaintext. If
specified, KeyManagementService will verify the integrity of the
received EncryptRequest.plaintext 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(EncryptRequest.plaintext) is equal to
EncryptRequest.plaintext_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 plaintext_crc32c = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the plaintextCrc32c field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static EncryptRequest.Builder newBuilder()
Returns
newBuilder(EncryptRequest prototype)
public static EncryptRequest.Builder newBuilder(EncryptRequest prototype)
Parameter
Returns
newBuilderForType()
public EncryptRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected EncryptRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static EncryptRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static EncryptRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static EncryptRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static EncryptRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static EncryptRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EncryptRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static EncryptRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static EncryptRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static EncryptRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static EncryptRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static EncryptRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static EncryptRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<EncryptRequest> parser()
Returns
toBuilder()
public EncryptRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
