- 2.77.0 (latest)
- 2.76.0
- 2.75.0
- 2.73.0
- 2.71.0
- 2.70.0
- 2.67.0
- 2.66.0
- 2.65.0
- 2.63.0
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.52.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.40.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.8
- 2.5.3
- 2.4.4
- 2.3.1
public static final class DecapsulateResponse.Builder extends GeneratedMessageV3.Builder<DecapsulateResponse.Builder> implements DecapsulateResponseOrBuilder
Response message for KeyManagementService.Decapsulate.
Protobuf type google.cloud.kms.v1.DecapsulateResponse
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DecapsulateResponse.BuilderImplements
DecapsulateResponseOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public DecapsulateResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
build()
public DecapsulateResponse build()
Returns | |
---|---|
Type | Description |
DecapsulateResponse |
buildPartial()
public DecapsulateResponse buildPartial()
Returns | |
---|---|
Type | Description |
DecapsulateResponse |
clear()
public DecapsulateResponse.Builder clear()
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
clearField(Descriptors.FieldDescriptor field)
public DecapsulateResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
clearName()
public DecapsulateResponse.Builder clearName()
The resource name of the CryptoKeyVersion used for decapsulation. Check this field to verify that the intended resource was used for decapsulation.
string name = 1;
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public DecapsulateResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
clearProtectionLevel()
public DecapsulateResponse.Builder clearProtectionLevel()
The ProtectionLevel of the CryptoKeyVersion used in decapsulation.
.google.cloud.kms.v1.ProtectionLevel protection_level = 5;
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
This builder for chaining. |
clearSharedSecret()
public DecapsulateResponse.Builder clearSharedSecret()
The decapsulated shared_secret originally encapsulated with the matching public key.
bytes shared_secret = 2;
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
This builder for chaining. |
clearSharedSecretCrc32C()
public DecapsulateResponse.Builder clearSharedSecretCrc32C()
Integrity verification field. A CRC32C checksum of the returned DecapsulateResponse.shared_secret. An integrity check of DecapsulateResponse.shared_secret can be performed by computing the CRC32C checksum of DecapsulateResponse.shared_secret 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: receiving this response message indicates that KeyManagementService is able to successfully decrypt the ciphertext. 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.
optional int64 shared_secret_crc32c = 3;
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
This builder for chaining. |
clearVerifiedCiphertextCrc32C()
public DecapsulateResponse.Builder clearVerifiedCiphertextCrc32C()
Integrity verification field. A flag indicating whether DecapsulateRequest.ciphertext_crc32c was received by KeyManagementService and used for the integrity verification of the ciphertext. A false value of this field indicates either that DecapsulateRequest.ciphertext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set DecapsulateRequest.ciphertext_crc32c but this field is still false, discard the response and perform a limited number of retries.
bool verified_ciphertext_crc32c = 4;
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
This builder for chaining. |
clone()
public DecapsulateResponse.Builder clone()
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
getDefaultInstanceForType()
public DecapsulateResponse getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
DecapsulateResponse |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getName()
public String getName()
The resource name of the CryptoKeyVersion used for decapsulation. Check this field to verify that the intended resource was used for decapsulation.
string name = 1;
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()
The resource name of the CryptoKeyVersion used for decapsulation. Check this field to verify that the intended resource was used for decapsulation.
string name = 1;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for name. |
getProtectionLevel()
public ProtectionLevel getProtectionLevel()
The ProtectionLevel of the CryptoKeyVersion used in decapsulation.
.google.cloud.kms.v1.ProtectionLevel protection_level = 5;
Returns | |
---|---|
Type | Description |
ProtectionLevel |
The protectionLevel. |
getProtectionLevelValue()
public int getProtectionLevelValue()
The ProtectionLevel of the CryptoKeyVersion used in decapsulation.
.google.cloud.kms.v1.ProtectionLevel protection_level = 5;
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for protectionLevel. |
getSharedSecret()
public ByteString getSharedSecret()
The decapsulated shared_secret originally encapsulated with the matching public key.
bytes shared_secret = 2;
Returns | |
---|---|
Type | Description |
ByteString |
The sharedSecret. |
getSharedSecretCrc32C()
public long getSharedSecretCrc32C()
Integrity verification field. A CRC32C checksum of the returned DecapsulateResponse.shared_secret. An integrity check of DecapsulateResponse.shared_secret can be performed by computing the CRC32C checksum of DecapsulateResponse.shared_secret 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: receiving this response message indicates that KeyManagementService is able to successfully decrypt the ciphertext. 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.
optional int64 shared_secret_crc32c = 3;
Returns | |
---|---|
Type | Description |
long |
The sharedSecretCrc32c. |
getVerifiedCiphertextCrc32C()
public boolean getVerifiedCiphertextCrc32C()
Integrity verification field. A flag indicating whether DecapsulateRequest.ciphertext_crc32c was received by KeyManagementService and used for the integrity verification of the ciphertext. A false value of this field indicates either that DecapsulateRequest.ciphertext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set DecapsulateRequest.ciphertext_crc32c but this field is still false, discard the response and perform a limited number of retries.
bool verified_ciphertext_crc32c = 4;
Returns | |
---|---|
Type | Description |
boolean |
The verifiedCiphertextCrc32c. |
hasSharedSecretCrc32C()
public boolean hasSharedSecretCrc32C()
Integrity verification field. A CRC32C checksum of the returned DecapsulateResponse.shared_secret. An integrity check of DecapsulateResponse.shared_secret can be performed by computing the CRC32C checksum of DecapsulateResponse.shared_secret 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: receiving this response message indicates that KeyManagementService is able to successfully decrypt the ciphertext. 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.
optional int64 shared_secret_crc32c = 3;
Returns | |
---|---|
Type | Description |
boolean |
Whether the sharedSecretCrc32c field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(DecapsulateResponse other)
public DecapsulateResponse.Builder mergeFrom(DecapsulateResponse other)
Parameter | |
---|---|
Name | Description |
other |
DecapsulateResponse |
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public DecapsulateResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public DecapsulateResponse.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final DecapsulateResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public DecapsulateResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
setName(String value)
public DecapsulateResponse.Builder setName(String value)
The resource name of the CryptoKeyVersion used for decapsulation. Check this field to verify that the intended resource was used for decapsulation.
string name = 1;
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public DecapsulateResponse.Builder setNameBytes(ByteString value)
The resource name of the CryptoKeyVersion used for decapsulation. Check this field to verify that the intended resource was used for decapsulation.
string name = 1;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
This builder for chaining. |
setProtectionLevel(ProtectionLevel value)
public DecapsulateResponse.Builder setProtectionLevel(ProtectionLevel value)
The ProtectionLevel of the CryptoKeyVersion used in decapsulation.
.google.cloud.kms.v1.ProtectionLevel protection_level = 5;
Parameter | |
---|---|
Name | Description |
value |
ProtectionLevel The protectionLevel to set. |
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
This builder for chaining. |
setProtectionLevelValue(int value)
public DecapsulateResponse.Builder setProtectionLevelValue(int value)
The ProtectionLevel of the CryptoKeyVersion used in decapsulation.
.google.cloud.kms.v1.ProtectionLevel protection_level = 5;
Parameter | |
---|---|
Name | Description |
value |
int The enum numeric value on the wire for protectionLevel to set. |
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public DecapsulateResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
setSharedSecret(ByteString value)
public DecapsulateResponse.Builder setSharedSecret(ByteString value)
The decapsulated shared_secret originally encapsulated with the matching public key.
bytes shared_secret = 2;
Parameter | |
---|---|
Name | Description |
value |
ByteString The sharedSecret to set. |
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
This builder for chaining. |
setSharedSecretCrc32C(long value)
public DecapsulateResponse.Builder setSharedSecretCrc32C(long value)
Integrity verification field. A CRC32C checksum of the returned DecapsulateResponse.shared_secret. An integrity check of DecapsulateResponse.shared_secret can be performed by computing the CRC32C checksum of DecapsulateResponse.shared_secret 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: receiving this response message indicates that KeyManagementService is able to successfully decrypt the ciphertext. 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.
optional int64 shared_secret_crc32c = 3;
Parameter | |
---|---|
Name | Description |
value |
long The sharedSecretCrc32c to set. |
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final DecapsulateResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
setVerifiedCiphertextCrc32C(boolean value)
public DecapsulateResponse.Builder setVerifiedCiphertextCrc32C(boolean value)
Integrity verification field. A flag indicating whether DecapsulateRequest.ciphertext_crc32c was received by KeyManagementService and used for the integrity verification of the ciphertext. A false value of this field indicates either that DecapsulateRequest.ciphertext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set DecapsulateRequest.ciphertext_crc32c but this field is still false, discard the response and perform a limited number of retries.
bool verified_ciphertext_crc32c = 4;
Parameter | |
---|---|
Name | Description |
value |
boolean The verifiedCiphertextCrc32c to set. |
Returns | |
---|---|
Type | Description |
DecapsulateResponse.Builder |
This builder for chaining. |