Class: Google::Apis::CloudkmsV1::RawDecryptRequest

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudkms_v1/classes.rb,
lib/google/apis/cloudkms_v1/representations.rb,
lib/google/apis/cloudkms_v1/representations.rb

Overview

Request message for KeyManagementService.RawDecrypt.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RawDecryptRequest

Returns a new instance of RawDecryptRequest.



2429
2430
2431
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 2429

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#additional_authenticated_data ⇒ String

Optional. Optional data that must match the data originally supplied in RawEncryptRequest.additional_authenticated_data. Corresponds to the JSON property additionalAuthenticatedData NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


2361
2362
2363
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 2361

def additional_authenticated_data
  @additional_authenticated_data
end

#additional_authenticated_data_crc32c ⇒ Fixnum

Optional. An optional CRC32C checksum of the RawDecryptRequest. 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. Corresponds to the JSON property additionalAuthenticatedDataCrc32c

Returns:

  • (Fixnum) 


2377
2378
2379
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 2377

def additional_authenticated_data_crc32c
  @additional_authenticated_data_crc32c
end

#ciphertext ⇒ String

Required. The encrypted data originally returned in RawEncryptResponse. ciphertext. Corresponds to the JSON property ciphertext NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


2384
2385
2386
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 2384

def ciphertext
  @ciphertext
end

#ciphertext_crc32c ⇒ Fixnum

Optional. An optional CRC32C checksum of the RawDecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received 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(ciphertext) is equal to 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. Corresponds to the JSON property ciphertextCrc32c

Returns:

  • (Fixnum) 


2398
2399
2400
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 2398

def ciphertext_crc32c
  @ciphertext_crc32c
end

#initialization_vector ⇒ String

Required. The initialization vector (IV) used during encryption, which must match the data originally provided in RawEncryptResponse.initialization_vector. Corresponds to the JSON property initializationVector NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


2405
2406
2407
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 2405

def initialization_vector
  @initialization_vector
end

#initialization_vector_crc32c ⇒ Fixnum

Optional. An optional CRC32C checksum of the RawDecryptRequest. 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. Corresponds to the JSON property initializationVectorCrc32c

Returns:

  • (Fixnum) 


2420
2421
2422
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 2420

def initialization_vector_crc32c
  @initialization_vector_crc32c
end

#tag_length ⇒ Fixnum

The length of the authentication tag that is appended to the end of the ciphertext. If unspecified (0), the default value for the key's algorithm will be used (for AES-GCM, the default value is 16). Corresponds to the JSON property tagLength

Returns:

  • (Fixnum) 


2427
2428
2429
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 2427

def tag_length
  @tag_length
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2434
2435
2436
2437
2438
2439
2440
2441
2442
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 2434

def update!(**args)
  @additional_authenticated_data = args[:additional_authenticated_data] if args.key?(:additional_authenticated_data)
  @additional_authenticated_data_crc32c = args[:additional_authenticated_data_crc32c] if args.key?(:additional_authenticated_data_crc32c)
  @ciphertext = args[:ciphertext] if args.key?(:ciphertext)
  @ciphertext_crc32c = args[:ciphertext_crc32c] if args.key?(:ciphertext_crc32c)
  @initialization_vector = args[:initialization_vector] if args.key?(:initialization_vector)
  @initialization_vector_crc32c = args[:initialization_vector_crc32c] if args.key?(:initialization_vector_crc32c)
  @tag_length = args[:tag_length] if args.key?(:tag_length)
end