Class GetIndexResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetIndexResponse.Builder,
GetIndexResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The identifier of the Amazon Q Business application associated with the index.static GetIndexResponse.Builder
builder()
The storage capacity units chosen for your Amazon Q Business index.final Instant
The Unix timestamp when the Amazon Q Business index was created.final String
The description for the Amazon Q Business index.final String
The name of the Amazon Q Business index.Configuration information for document attributes or metadata.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ErrorDetail
error()
When theStatus
field value isFAILED
, theErrorMessage
field contains a message that explains why.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the DocumentAttributeConfigurations property.final int
hashCode()
final String
indexArn()
The Amazon Resource Name (ARN) of the Amazon Q Business index.final String
indexId()
The identifier of the Amazon Q Business index.final IndexStatistics
Provides information about the number of documents indexed.static Class
<? extends GetIndexResponse.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 IndexType
type()
The type of index attached to your Amazon Q Business application.final String
The type of index attached to your Amazon Q Business application.final Instant
The Unix timestamp when the Amazon Q Business index was last updated.Methods inherited from class software.amazon.awssdk.services.qbusiness.model.QBusinessResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
applicationId
The identifier of the Amazon Q Business application associated with the index.
- Returns:
- The identifier of the Amazon Q Business application associated with the index.
-
indexId
The identifier of the Amazon Q Business index.
- Returns:
- The identifier of the Amazon Q Business index.
-
displayName
The name of the Amazon Q Business index.
- Returns:
- The name of the Amazon Q Business index.
-
type
The type of index attached to your Amazon Q Business application.
If the service returns an enum value that is not available in the current SDK version,
type
will returnIndexType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of index attached to your Amazon Q Business application.
- See Also:
-
typeAsString
The type of index attached to your Amazon Q Business application.
If the service returns an enum value that is not available in the current SDK version,
type
will returnIndexType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of index attached to your Amazon Q Business application.
- See Also:
-
indexArn
The Amazon Resource Name (ARN) of the Amazon Q Business index.
- Returns:
- The Amazon Resource Name (ARN) of the Amazon Q Business index.
-
status
The current status of the index. When the value is
ACTIVE
, the index is ready for use. If theStatus
field value isFAILED
, theErrorMessage
field contains a message that explains why.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 value is
ACTIVE
, the index is ready for use. If theStatus
field value isFAILED
, theErrorMessage
field contains a message that explains why. - See Also:
-
statusAsString
The current status of the index. When the value is
ACTIVE
, the index is ready for use. If theStatus
field value isFAILED
, theErrorMessage
field contains a message that explains why.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 value is
ACTIVE
, the index is ready for use. If theStatus
field value isFAILED
, theErrorMessage
field contains a message that explains why. - See Also:
-
description
The description for the Amazon Q Business index.
- Returns:
- The description for the Amazon Q Business index.
-
createdAt
The Unix timestamp when the Amazon Q Business index was created.
- Returns:
- The Unix timestamp when the Amazon Q Business index was created.
-
updatedAt
The Unix timestamp when the Amazon Q Business index was last updated.
- Returns:
- The Unix timestamp when the Amazon Q Business index was last updated.
-
capacityConfiguration
The storage capacity units chosen for your Amazon Q Business index.
- Returns:
- The storage capacity units chosen for your Amazon Q Business index.
-
hasDocumentAttributeConfigurations
public final boolean hasDocumentAttributeConfigurations()For responses, this returns true if the service returned a value for the DocumentAttributeConfigurations 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. -
documentAttributeConfigurations
Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
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
hasDocumentAttributeConfigurations()
method.- Returns:
- Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
-
error
When the
Status
field value isFAILED
, theErrorMessage
field contains a message that explains why.- Returns:
- When the
Status
field value isFAILED
, theErrorMessage
field contains a message that explains why.
-
indexStatistics
Provides information about the number of documents indexed.
- Returns:
- Provides information about the number of documents indexed.
-
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<GetIndexResponse.Builder,
GetIndexResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
Description copied from class:SdkResponse
Used 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:
getValueForField
in 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
-