Class UpdateMemoryRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<UpdateMemoryRequest.Builder,UpdateMemoryRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal StringactorId()The ID of the actor that the memory must belong to.static UpdateMemoryRequest.Builderbuilder()final Stringcontent()Replacement memory text.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the Metadata property.final StringmemoryId()The ID of the memory to update.metadata()The metadata tags to apply.final MetadataModeHowmetadatacombines with what is stored.final StringHowmetadatacombines with what is stored.static Class<? extends UpdateMemoryRequest.Builder> final StringspaceId()The ID of the space that owns the memory, for examplesp-02864597b164.final StringThe name of the strategy that the memory must belong to.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The ID of the memory to update.
- Returns:
- The ID of the memory to update.
-
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 theisEmpty()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
The metadata tags to apply. By default this map replaces the stored metadata, and any key not present is removed. Set
metadataModetoMERGEto keep the keys you don't supply. Limits apply to the resulting metadata, not to the request. Keys that begin withx-amz-and the keydocumentS3Sourceare reserved: a request that sets one fails withValidationException.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
metadataModetoMERGEto keep the keys you don't supply. Limits apply to the resulting metadata, not to the request. Keys that begin withx-amz-and the keydocumentS3Sourceare reserved: a request that sets one fails withValidationException.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
How
metadatacombines with what is stored. The default isREPLACE.If the service returns an enum value that is not available in the current SDK version,
metadataModewill returnMetadataMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommetadataModeAsString().- Returns:
- How
metadatacombines with what is stored. The default isREPLACE. - See Also:
-
metadataModeAsString
How
metadatacombines with what is stored. The default isREPLACE.If the service returns an enum value that is not available in the current SDK version,
metadataModewill returnMetadataMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommetadataModeAsString().- Returns:
- How
metadatacombines with what is stored. The default isREPLACE. - See Also:
-
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
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
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateMemoryRequest.Builder,UpdateMemoryRequest> - Specified by:
toBuilderin classOpenSearchMemoryRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. 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, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-