Class EncryptionConfig

java.lang.Object
software.amazon.awssdk.services.xray.model.EncryptionConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EncryptionConfig.Builder,EncryptionConfig>
@Generated("software.amazon.awssdk:codegen") public final class EncryptionConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EncryptionConfig.Builder,EncryptionConfig>

A configuration document that specifies encryption configuration settings.

See Also:

  • Method Details

    • keyId

      public final String keyId()

      The ID of the KMS key used for encryption, if applicable.

      Returns:
      The ID of the KMS key used for encryption, if applicable.

    • status

      public final EncryptionStatus status()

      The encryption status. While the status is UPDATING, X-Ray may encrypt data with a combination of the new and old settings.

      If the service returns an enum value that is not available in the current SDK version, status will return EncryptionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The encryption status. While the status is UPDATING, X-Ray may encrypt data with a combination of the new and old settings.
      See Also:

    • statusAsString

      public final String statusAsString()

      The encryption status. While the status is UPDATING, X-Ray may encrypt data with a combination of the new and old settings.

      If the service returns an enum value that is not available in the current SDK version, status will return EncryptionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The encryption status. While the status is UPDATING, X-Ray may encrypt data with a combination of the new and old settings.
      See Also:

    • type

      public final EncryptionType type()

      The type of encryption. Set to KMS for encryption with KMS keys. Set to NONE for default encryption.

      If the service returns an enum value that is not available in the current SDK version, type will return EncryptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of encryption. Set to KMS for encryption with KMS keys. Set to NONE for default encryption.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of encryption. Set to KMS for encryption with KMS keys. Set to NONE for default encryption.

      If the service returns an enum value that is not available in the current SDK version, type will return EncryptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of encryption. Set to KMS for encryption with KMS keys. Set to NONE for default encryption.
      See Also:

    • toBuilder

      public EncryptionConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<EncryptionConfig.Builder,EncryptionConfig>
      Returns:
      a builder for type T

    • builder

      public static EncryptionConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EncryptionConfig.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.