Class EffectiveLifecyclePolicyDetail

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

Error information for an OpenSearch Serverless request.

See Also:

  • Method Details

    • type

      public final LifecyclePolicyType type()

      The type of lifecycle policy.

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

      Returns:
      The type of lifecycle policy.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of lifecycle policy.

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

      Returns:
      The type of lifecycle policy.
      See Also:

    • resource

      public final String resource()

      The name of the OpenSearch Serverless index resource.

      Returns:
      The name of the OpenSearch Serverless index resource.

    • policyName

      public final String policyName()

      The name of the lifecycle policy.

      Returns:
      The name of the lifecycle policy.

    • resourceType

      public final ResourceType resourceType()

      The type of OpenSearch Serverless resource. Currently, the only supported resource is index.

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

      Returns:
      The type of OpenSearch Serverless resource. Currently, the only supported resource is index.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of OpenSearch Serverless resource. Currently, the only supported resource is index.

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

      Returns:
      The type of OpenSearch Serverless resource. Currently, the only supported resource is index.
      See Also:

    • retentionPeriod

      public final String retentionPeriod()

      The minimum number of index retention in days or hours. This is an optional parameter that will return only if it’s set.

      Returns:
      The minimum number of index retention in days or hours. This is an optional parameter that will return only if it’s set.

    • noMinRetentionPeriod

      public final Boolean noMinRetentionPeriod()

      The minimum number of index retention days set. That is an optional param that will return as true if the minimum number of days or hours is not set to a index resource.

      Returns:
      The minimum number of index retention days set. That is an optional param that will return as true if the minimum number of days or hours is not set to a index resource.

    • toBuilder

      public EffectiveLifecyclePolicyDetail.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<EffectiveLifecyclePolicyDetail.Builder,EffectiveLifecyclePolicyDetail>
      Returns:
      a builder for type T

    • builder

      public static EffectiveLifecyclePolicyDetail.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EffectiveLifecyclePolicyDetail.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.