Package com.azure.resourcemanager.cosmos.models

Class KeyWrapMetadata

java.lang.Object
com.azure.resourcemanager.cosmos.models.KeyWrapMetadata
public final class KeyWrapMetadata extends Object
Represents key wrap metadata that a key wrapping provider can use to wrap/unwrap a client encryption key.

  • Constructor Details

    • KeyWrapMetadata

      public KeyWrapMetadata()
      Creates an instance of KeyWrapMetadata class.

  • Method Details

    • name

      public String name()
      Get the name property: The name of associated KeyEncryptionKey (aka CustomerManagedKey).
      Returns:
      the name value.

    • withName

      public KeyWrapMetadata withName(String name)
      Set the name property: The name of associated KeyEncryptionKey (aka CustomerManagedKey).
      Parameters:
      name - the name value to set.
      Returns:
      the KeyWrapMetadata object itself.

    • type

      public String type()
      Get the type property: ProviderName of KeyStoreProvider.
      Returns:
      the type value.

    • withType

      public KeyWrapMetadata withType(String type)
      Set the type property: ProviderName of KeyStoreProvider.
      Parameters:
      type - the type value to set.
      Returns:
      the KeyWrapMetadata object itself.

    • value

      public String value()
      Get the value property: Reference / link to the KeyEncryptionKey.
      Returns:
      the value value.

    • withValue

      public KeyWrapMetadata withValue(String value)
      Set the value property: Reference / link to the KeyEncryptionKey.
      Parameters:
      value - the value value to set.
      Returns:
      the KeyWrapMetadata object itself.

    • algorithm

      public String algorithm()
      Get the algorithm property: Algorithm used in wrapping and unwrapping of the data encryption key.
      Returns:
      the algorithm value.

    • withAlgorithm

      public KeyWrapMetadata withAlgorithm(String algorithm)
      Set the algorithm property: Algorithm used in wrapping and unwrapping of the data encryption key.
      Parameters:
      algorithm - the algorithm value to set.
      Returns:
      the KeyWrapMetadata object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.