Class MemoryStrategy

java.lang.Object
software.amazon.awssdk.services.opensearchmemory.model.MemoryStrategy
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<MemoryStrategy.Builder,MemoryStrategy>

@Generated("software.amazon.awssdk:codegen") public final class MemoryStrategy extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MemoryStrategy.Builder,MemoryStrategy>

A memory strategy: how a space extracts one kind of memory from its events.

See Also:
  • Method Details

    • type

      public final MemoryStrategyType type()

      The type of memory the strategy extracts.

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

      Returns:
      The type of memory the strategy extracts.
      See Also:
    • typeAsString

      public final String typeAsString()

      The type of memory the strategy extracts.

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

      Returns:
      The type of memory the strategy extracts.
      See Also:
    • name

      public final String name()

      A name for the strategy, unique within the space. Omit it to have the service generate one from the type, for example semantic_1. The name must be 1 to 64 characters: letters, digits, periods, hyphens, and underscores, starting with a letter or digit. A strategy's name can't be changed, and the strategy's memories are stored under it: a strategy added under a new name starts with no memories.

      Returns:
      A name for the strategy, unique within the space. Omit it to have the service generate one from the type, for example semantic_1. The name must be 1 to 64 characters: letters, digits, periods, hyphens, and underscores, starting with a letter or digit. A strategy's name can't be changed, and the strategy's memories are stored under it: a strategy added under a new name starts with no memories.
    • description

      public final String description()

      A description of the strategy.

      Returns:
      A description of the strategy.
    • configuration

      public final MemoryStrategyConfiguration configuration()

      Settings for the strategy. When you create a strategy, omit it to use the defaults for the strategy's type.

      A CUSTOM strategy must set extractionPrompt.

      Returns:
      Settings for the strategy. When you create a strategy, omit it to use the defaults for the strategy's type.

      A CUSTOM strategy must set extractionPrompt.

    • toBuilder

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

      public static MemoryStrategy.Builder builder()
    • serializableBuilderClass

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