Class RecordExpirySpecification

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

Specifies the record expiry (long-term memory time-to-live) applied to the records in a batch request. Provide exactly one of recordExpiryDurationDays or action. Set recordExpiryDurationDays to configure or update the expiry, or set action to REMOVE to remove a previously configured expiry.

See Also:

  • Method Details

    • recordExpiryDurationDays

      public final Integer recordExpiryDurationDays()

      The duration, in days, after which the records in this request expire. The minimum is 31 days.

      Returns:
      The duration, in days, after which the records in this request expire. The minimum is 31 days.

    • action

      public final RecordExpiryAction action()

      The action to apply to the existing record expiry configuration. Set to REMOVE to remove a previously configured expiry so that the records no longer expire. This value does not apply when creating records.

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

      Returns:
      The action to apply to the existing record expiry configuration. Set to REMOVE to remove a previously configured expiry so that the records no longer expire. This value does not apply when creating records.
      See Also:

    • actionAsString

      public final String actionAsString()

      The action to apply to the existing record expiry configuration. Set to REMOVE to remove a previously configured expiry so that the records no longer expire. This value does not apply when creating records.

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

      Returns:
      The action to apply to the existing record expiry configuration. Set to REMOVE to remove a previously configured expiry so that the records no longer expire. This value does not apply when creating records.
      See Also:

    • toBuilder

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

    • builder

      public static RecordExpirySpecification.Builder builder()

    • serializableBuilderClass

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

    • fromRecordExpiryDurationDays

      public static RecordExpirySpecification fromRecordExpiryDurationDays(Integer recordExpiryDurationDays)
      Create an instance of this class with recordExpiryDurationDays() initialized to the given value.

      The duration, in days, after which the records in this request expire. The minimum is 31 days.

      Parameters:
      recordExpiryDurationDays - The duration, in days, after which the records in this request expire. The minimum is 31 days.

    • fromAction

      public static RecordExpirySpecification fromAction(String action)
      Create an instance of this class with actionAsString() initialized to the given value.

      The action to apply to the existing record expiry configuration. Set to REMOVE to remove a previously configured expiry so that the records no longer expire. This value does not apply when creating records.

      Parameters:
      action - The action to apply to the existing record expiry configuration. Set to REMOVE to remove a previously configured expiry so that the records no longer expire. This value does not apply when creating records.
      See Also:

    • fromAction

      public static RecordExpirySpecification fromAction(RecordExpiryAction action)
      Create an instance of this class with actionAsString() initialized to the given value.

      The action to apply to the existing record expiry configuration. Set to REMOVE to remove a previously configured expiry so that the records no longer expire. This value does not apply when creating records.

      Parameters:
      action - The action to apply to the existing record expiry configuration. Set to REMOVE to remove a previously configured expiry so that the records no longer expire. This value does not apply when creating records.
      See Also:

    • type

      public RecordExpirySpecification.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be RecordExpirySpecification.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be RecordExpirySpecification.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

    • 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.