Class UpdateMemoryRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateMemoryRequest.Builder,UpdateMemoryRequest>

@Generated("software.amazon.awssdk:codegen") public final class UpdateMemoryRequest extends OpenSearchMemoryRequest implements ToCopyableBuilder<UpdateMemoryRequest.Builder,UpdateMemoryRequest>
  • Method Details

    • spaceId

      public final String spaceId()

      The ID of the space that owns the memory, for example sp-02864597b164.

      Returns:
      The ID of the space that owns the memory, for example sp-02864597b164.
    • memoryId

      public final String memoryId()

      The ID of the memory to update.

      Returns:
      The ID of the memory to update.
    • content

      public final String content()

      Replacement memory text. Supplying it re-embeds the memory. Omit to leave the text unchanged.

      Returns:
      Replacement memory text. Supplying it re-embeds the memory. Omit to leave the text unchanged.
    • hasMetadata

      public final boolean hasMetadata()
      For responses, this returns true if the service returned a value for the Metadata property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • metadata

      public final Map<String,String> metadata()

      The metadata tags to apply. By default this map replaces the stored metadata, and any key not present is removed. Set metadataMode to MERGE to keep the keys you don't supply. Limits apply to the resulting metadata, not to the request. Keys that begin with x-amz- and the key documentS3Source are reserved: a request that sets one fails with ValidationException.

      A space can use at most 50 distinct metadata keys across all of its events and memories. A request that would add a key beyond that fails with ValidationException. Reuse an existing key instead.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetadata() method.

      Returns:
      The metadata tags to apply. By default this map replaces the stored metadata, and any key not present is removed. Set metadataMode to MERGE to keep the keys you don't supply. Limits apply to the resulting metadata, not to the request. Keys that begin with x-amz- and the key documentS3Source are reserved: a request that sets one fails with ValidationException.

      A space can use at most 50 distinct metadata keys across all of its events and memories. A request that would add a key beyond that fails with ValidationException. Reuse an existing key instead.

    • metadataMode

      public final MetadataMode metadataMode()

      How metadata combines with what is stored. The default is REPLACE.

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

      Returns:
      How metadata combines with what is stored. The default is REPLACE.
      See Also:
    • metadataModeAsString

      public final String metadataModeAsString()

      How metadata combines with what is stored. The default is REPLACE.

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

      Returns:
      How metadata combines with what is stored. The default is REPLACE.
      See Also:
    • actorId

      public final String actorId()

      The ID of the actor that the memory must belong to. Omit it to skip this check. If it doesn't match the stored memory, the call fails with ResourceNotFoundException, as if the memory did not exist.

      Returns:
      The ID of the actor that the memory must belong to. Omit it to skip this check. If it doesn't match the stored memory, the call fails with ResourceNotFoundException, as if the memory did not exist.
    • strategyName

      public final String strategyName()

      The name of the strategy that the memory must belong to. Omit it to skip this check. If it doesn't match the stored memory, the call fails with ResourceNotFoundException, as if the memory did not exist.

      Returns:
      The name of the strategy that the memory must belong to. Omit it to skip this check. If it doesn't match the stored memory, the call fails with ResourceNotFoundException, as if the memory did not exist.
    • toBuilder

      public UpdateMemoryRequest.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<UpdateMemoryRequest.Builder,UpdateMemoryRequest>
      Specified by:
      toBuilder in class OpenSearchMemoryRequest
      Returns:
      a builder for type T
    • builder

      public static UpdateMemoryRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends UpdateMemoryRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • 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.