Class Index
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Index.Builder,
Index>
Summary information for your Amazon Q Business index.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Index.Builder
builder()
final Instant
The Unix timestamp when the index was created.final String
The name of the index.final boolean
final boolean
equalsBySdkFields
(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) final int
hashCode()
final String
indexId()
The identifier for the index.static Class
<? extends Index.Builder> final IndexStatus
status()
The current status of the index.final String
The current status of the index.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Instant
The Unix timestamp when the index was last updated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
displayName
The name of the index.
- Returns:
- The name of the index.
-
indexId
The identifier for the index.
- Returns:
- The identifier for the index.
-
createdAt
The Unix timestamp when the index was created.
- Returns:
- The Unix timestamp when the index was created.
-
updatedAt
The Unix timestamp when the index was last updated.
- Returns:
- The Unix timestamp when the index was last updated.
-
status
The current status of the index. When the status is
ACTIVE
, the index is ready.If the service returns an enum value that is not available in the current SDK version,
status
will returnIndexStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the index. When the status is
ACTIVE
, the index is ready. - See Also:
-
statusAsString
The current status of the index. When the status is
ACTIVE
, the index is ready.If the service returns an enum value that is not available in the current SDK version,
status
will returnIndexStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the index. When the status is
ACTIVE
, the index is ready. - See Also:
-
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 interfaceToCopyableBuilder<Index.Builder,
Index> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in 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
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. -
getValueForField
-
sdkFields
-