Class GetSpaceResponse
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetSpaceResponse.Builder,GetSpaceResponse>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal Stringarn()The Amazon Resource Name (ARN) of the space.static GetSpaceResponse.Builderbuilder()final InstantWhen the space was created.final EncryptionConfigurationThe AWS KMS key the space was created with.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.final StringThe model that extracts and consolidates memories for the space.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse.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.final List<MemoryStrategy> The space's memory strategies, including the names the service generated for strategies created without one.final Stringname()The name of the space.static Class<? extends GetSpaceResponse.Builder> final StringspaceId()The ID of the space.final SpaceStatusstatus()The status of the space.final StringThe status of the space.final StringDetails about why the space isFAILED.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.services.opensearchmemory.model.OpenSearchMemoryResponse
responseMetadataMethods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponseMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
spaceId
-
arn
The Amazon Resource Name (ARN) of the space.
- Returns:
- The Amazon Resource Name (ARN) of the space.
-
name
-
status
The status of the space.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnSpaceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the space.
- See Also:
-
statusAsString
The status of the space.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnSpaceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the space.
- See Also:
-
statusReason
Details about why the space is
FAILED. Read it only whenstatusisFAILED: it can still hold the reason for an earlier failure.- Returns:
- Details about why the space is
FAILED. Read it only whenstatusisFAILED: it can still hold the reason for an earlier failure.
-
createdAt
-
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 space's memory strategies, including the names the service generated for strategies created without one. Empty for a space that has no memory strategies.
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 space's memory strategies, including the names the service generated for strategies created without one. Empty for a space that has no memory strategies.
-
eventExpiryDays
How many days the space keeps each event. Absent when it was never set, in which case the default of 90 days applies.
- Returns:
- How many days the space keeps each event. Absent when it was never set, in which case the default of 90 days applies.
-
memoryExpiryDays
How many days the space keeps each memory. 0 means memories never expire. Absent when it was never set, in which case memories never expire.
- Returns:
- How many days the space keeps each memory. 0 means memories never expire. Absent when it was never set, in which case memories never expire.
-
extractionModelId
The model that extracts and consolidates memories for the space. Absent when it was never set, in which case the service default applies.
- Returns:
- The model that extracts and consolidates memories for the space. Absent when it was never set, in which case the service default applies.
-
encryptionConfiguration
The AWS KMS key the space was created with. Absent when the space uses an AWS owned key.
- Returns:
- The AWS KMS key the space was created with. Absent when the space uses an AWS owned key.
-
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<GetSpaceResponse.Builder,GetSpaceResponse> - Specified by:
toBuilderin classAwsResponse- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsResponse
-
equals
- Overrides:
equalsin classAwsResponse
-
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:SdkResponseUsed to retrieve the value of a field from any class that extendsSdkResponse. 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, theSdkResponse.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkResponse- 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.
-