Class UpdateSpaceRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<UpdateSpaceRequest.Builder,UpdateSpaceRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic UpdateSpaceRequest.Builderbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final IntegerHow many days the space keeps each event, from 1 to 365.final StringThe model that extracts and consolidates memories for every strategy in the space:anthropic.claude-opus-5-5oranthropic.claude-haiku-5-5.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 MemoryStrategies property.final IntegerHow many days the space keeps each memory, from 0 to 3650.final List<MemoryStrategy> The complete new list of memory strategies.static Class<? extends UpdateSpaceRequest.Builder> final StringspaceId()The ID of the space to update.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 to update.
- Returns:
- The ID of the space to update.
-
hasMemoryStrategies
public final boolean hasMemoryStrategies()For responses, this returns true if the service returned a value for the MemoryStrategies 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. -
memoryStrategies
The complete new list of memory strategies. The service removes strategies that aren't in the list from the space. Removing a strategy stops extraction for it but doesn't delete its memories: they're kept, until they expire if the space sets
memoryExpiryDays, and they're available again if you later add a strategy with the sametypeandname. To delete them, useDeleteMemorybefore you remove the strategy, or delete the space.To keep a strategy, include it with the same
typeandnamethatGetSpacereturns. For a kept strategy, anyconfigurationmember you omit keeps its current value. It doesn't return to the default, and you can't clear a member once it's set. Omit this field to leave the strategies unchanged. The list must name at least one strategy. You can't remove every strategy from a space withUpdateSpace.The serialized list can be at most 384 KiB.
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
hasMemoryStrategies()method.- Returns:
- The complete new list of memory strategies. The service removes strategies that aren't in the list from
the space. Removing a strategy stops extraction for it but doesn't delete its memories: they're kept,
until they expire if the space sets
memoryExpiryDays, and they're available again if you later add a strategy with the sametypeandname. To delete them, useDeleteMemorybefore you remove the strategy, or delete the space.To keep a strategy, include it with the same
typeandnamethatGetSpacereturns. For a kept strategy, anyconfigurationmember you omit keeps its current value. It doesn't return to the default, and you can't clear a member once it's set. Omit this field to leave the strategies unchanged. The list must name at least one strategy. You can't remove every strategy from a space withUpdateSpace.The serialized list can be at most 384 KiB.
-
eventExpiryDays
How many days the space keeps each event, from 1 to 365. Omit it to leave the current value unchanged. Events already stored keep the expiry they were written with.
- Returns:
- How many days the space keeps each event, from 1 to 365. Omit it to leave the current value unchanged. Events already stored keep the expiry they were written with.
-
memoryExpiryDays
How many days the space keeps each memory, from 0 to 3650. 0 means memories never expire. Omit it to leave the current value unchanged. You can't clear the setting. To make memories written from then on never expire, send 0.
GetSpacethen returns 0.A change applies to memories written after it. Memories already stored keep the expiry they were written with. A memory the service rewrites later, such as a summary it keeps up to date, takes the setting in force at that rewrite. A change moves the space to
UPDATING. Sending the value that the space has stored doesn't.- Returns:
- How many days the space keeps each memory, from 0 to 3650. 0 means memories never expire. Omit it to
leave the current value unchanged. You can't clear the setting. To make memories written from then on
never expire, send 0.
GetSpacethen returns 0.A change applies to memories written after it. Memories already stored keep the expiry they were written with. A memory the service rewrites later, such as a summary it keeps up to date, takes the setting in force at that rewrite. A change moves the space to
UPDATING. Sending the value that the space has stored doesn't.
-
extractionModelId
The model that extracts and consolidates memories for every strategy in the space:
anthropic.claude-opus-5-5oranthropic.claude-haiku-5-5. Omit it to leave the current value unchanged. Once set, it can't be cleared back to the service default.- Returns:
- The model that extracts and consolidates memories for every strategy in the space:
anthropic.claude-opus-5-5oranthropic.claude-haiku-5-5. Omit it to leave the current value unchanged. Once set, it can't be cleared back to the service default.
-
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<UpdateSpaceRequest.Builder,UpdateSpaceRequest> - 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.
-