public final class RawEncryptRequest extends GeneratedMessageV3 implements RawEncryptRequestOrBuilder
Request message for KeyManagementService.RawEncrypt.
Protobuf type google.cloud.kms.v1.RawEncryptRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER
public static final int ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ADDITIONAL_AUTHENTICATED_DATA_FIELD_NUMBER
public static final int ADDITIONAL_AUTHENTICATED_DATA_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
INITIALIZATION_VECTOR_CRC32C_FIELD_NUMBER
public static final int INITIALIZATION_VECTOR_CRC32C_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
INITIALIZATION_VECTOR_FIELD_NUMBER
public static final int INITIALIZATION_VECTOR_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PLAINTEXT_CRC32C_FIELD_NUMBER
public static final int PLAINTEXT_CRC32C_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PLAINTEXT_FIELD_NUMBER
public static final int PLAINTEXT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static RawEncryptRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static RawEncryptRequest.Builder newBuilder()
newBuilder(RawEncryptRequest )
public static RawEncryptRequest.Builder newBuilder(RawEncryptRequest )
public static RawEncryptRequest parseDelimitedFrom(InputStream input)
public static RawEncryptRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static RawEncryptRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RawEncryptRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static RawEncryptRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RawEncryptRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RawEncryptRequest parseFrom(CodedInputStream input)
public static RawEncryptRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RawEncryptRequest parseFrom(InputStream input)
public static RawEncryptRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static RawEncryptRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RawEncryptRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<RawEncryptRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
OverridesgetAdditionalAuthenticatedData()
public ByteString getAdditionalAuthenticatedData()
Optional. Optional data that, if specified, must also be provided during decryption through RawDecryptRequest.additional_authenticated_data.
This field may only be used in conjunction with an algorithm that accepts additional authenticated data (for example, AES-GCM).
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 additional_authenticated_data = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
ByteString | The additionalAuthenticatedData. |
getAdditionalAuthenticatedDataCrc32C()
public Int64Value getAdditionalAuthenticatedDataCrc32C()
Optional. An optional CRC32C checksum of the RawEncryptRequest.additional_authenticated_data. If specified, KeyManagementService will verify the integrity of the received 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(additional_authenticated_data) is equal to 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 = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
Int64Value | The additionalAuthenticatedDataCrc32c. |
getAdditionalAuthenticatedDataCrc32COrBuilder()
public Int64ValueOrBuilder getAdditionalAuthenticatedDataCrc32COrBuilder()
Optional. An optional CRC32C checksum of the RawEncryptRequest.additional_authenticated_data. If specified, KeyManagementService will verify the integrity of the received 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(additional_authenticated_data) is equal to 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 = 5 [(.google.api.field_behavior) = OPTIONAL];
getDefaultInstanceForType()
public RawEncryptRequest getDefaultInstanceForType()
getInitializationVector()
public ByteString getInitializationVector()
Optional. A customer-supplied initialization vector that will be used for encryption. If it is not provided for AES-CBC and AES-CTR, one will be generated. It will be returned in RawEncryptResponse.initialization_vector.
bytes initialization_vector = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
ByteString | The initializationVector. |
getInitializationVectorCrc32C()
public Int64Value getInitializationVectorCrc32C()
Optional. An optional CRC32C checksum of the RawEncryptRequest.initialization_vector. If specified, KeyManagementService will verify the integrity of the received initialization_vector 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(initialization_vector) is equal to initialization_vector_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 initialization_vector_crc32c = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
Int64Value | The initializationVectorCrc32c. |
getInitializationVectorCrc32COrBuilder()
public Int64ValueOrBuilder getInitializationVectorCrc32COrBuilder()
Optional. An optional CRC32C checksum of the RawEncryptRequest.initialization_vector. If specified, KeyManagementService will verify the integrity of the received initialization_vector 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(initialization_vector) is equal to initialization_vector_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 initialization_vector_crc32c = 7 [(.google.api.field_behavior) = OPTIONAL];
getName()
Required. The resource name of the CryptoKeyVersion to use for encryption.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes()
Required. The resource name of the CryptoKeyVersion to use for encryption.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name. |
getParserForType()
public Parser<RawEncryptRequest> getParserForType()
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 RawEncryptRequest.plaintext. If specified, KeyManagementService will verify the integrity of the received 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(plaintext) is equal to 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 = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
Int64Value | The plaintextCrc32c. |
getPlaintextCrc32COrBuilder()
public Int64ValueOrBuilder getPlaintextCrc32COrBuilder()
Optional. An optional CRC32C checksum of the RawEncryptRequest.plaintext. If specified, KeyManagementService will verify the integrity of the received 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(plaintext) is equal to 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 = 4 [(.google.api.field_behavior) = OPTIONAL];
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
OverrideshasAdditionalAuthenticatedDataCrc32C()
public boolean hasAdditionalAuthenticatedDataCrc32C()
Optional. An optional CRC32C checksum of the RawEncryptRequest.additional_authenticated_data. If specified, KeyManagementService will verify the integrity of the received 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(additional_authenticated_data) is equal to 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 = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
boolean | Whether the additionalAuthenticatedDataCrc32c field is set. |
hasInitializationVectorCrc32C()
public boolean hasInitializationVectorCrc32C()
Optional. An optional CRC32C checksum of the RawEncryptRequest.initialization_vector. If specified, KeyManagementService will verify the integrity of the received initialization_vector 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(initialization_vector) is equal to initialization_vector_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 initialization_vector_crc32c = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
boolean | Whether the initializationVectorCrc32c field is set. |
hasPlaintextCrc32C()
public boolean hasPlaintextCrc32C()
Optional. An optional CRC32C checksum of the RawEncryptRequest.plaintext. If specified, KeyManagementService will verify the integrity of the received 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(plaintext) is equal to 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 = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
boolean | Whether the plaintextCrc32c field is set. |
hashCode()
| Returns |
|---|
| Type | Description |
int | |
OverridesinternalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
isInitialized()
public final boolean isInitialized()
newBuilderForType()
public RawEncryptRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RawEncryptRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
toBuilder()
public RawEncryptRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)