All Implemented Interfaces:
ApiRequest<Decrypt.Request>
Enclosing class:
Decrypt

public static final class Decrypt.Request extends OciRequestBase<Decrypt.Request>
Request object. Can be configured with additional headers, query parameters etc.
  • Method Details

    • builder

      public static Decrypt.Request builder()
      Fluent API builder for configuring a request. The request builder is passed as is, without a build method. The equivalent of a build method is ApiJsonBuilder.toJson(jakarta.json.JsonBuilderFactory) used by the RestApi.
      Returns:
      new request builder
    • cipherText

      public Decrypt.Request cipherText(String cipherText)
      The data to decrypt.
      Parameters:
      cipherText - encrypted data
      Returns:
      updated request
    • keyId

      public Decrypt.Request keyId(String keyOcid)
      The OCID of the key to encrypt with. Required.
      Parameters:
      keyOcid - OCID of the key
      Returns:
      updated request
    • context

      public Decrypt.Request context(String contextData)
      Information that can be used to provide an encryption context for the encrypted data. The length of the string representation of the associated data must be fewer than 4096 characters. Optional.
      Parameters:
      contextData - context
      Returns:
      updated request
    • algorithm

      public Decrypt.Request algorithm(String algorithm)
      The encryption algorithm to use to encrypt and decrypt data with a customer-managed key. AES_256_GCM indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and that the mode of encryption is the Galois/Counter Mode (GCM). RSA_OAEP_SHA_1 indicates that the key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP). RSA_OAEP_SHA_256 indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash and uses OAEP. Optional, defaults to AES_256_GCM.
      Parameters:
      algorithm - algorithm to use
      Returns:
      updated request
      See Also:
    • keyVersionId

      public Decrypt.Request keyVersionId(String versionOcid)
      The OCID of the key version used to encrypt the ciphertext. Optional.
      Parameters:
      versionOcid - OCID of the key version
      Returns:
      updated request