@Generated(value="software.amazon.awssdk:codegen") public final class DescribeIndexResponse extends KendraResponse implements ToCopyableBuilder<DescribeIndexResponse.Builder,DescribeIndexResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeIndexResponse.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeIndexResponse.Builder |
builder() |
CapacityUnitsConfiguration |
capacityUnits()
For enterprise edtion indexes, you can choose to use additional capacity to meet the needs of your application.
|
Instant |
createdAt()
The Unix datetime that the index was created.
|
String |
description()
The description of the index.
|
List<DocumentMetadataConfiguration> |
documentMetadataConfigurations()
Configuration settings for any metadata applied to the documents in the index.
|
IndexEdition |
edition()
The Amazon Kendra edition used for the index.
|
String |
editionAsString()
The Amazon Kendra edition used for the index.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
String |
errorMessage()
When th e
Status field value is FAILED , the ErrorMessage field contains a
message that explains why. |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
boolean |
hasDocumentMetadataConfigurations()
Returns true if the DocumentMetadataConfigurations property was specified by the sender (it may be empty), or
false if the sender did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasUserTokenConfigurations()
Returns true if the UserTokenConfigurations property was specified by the sender (it may be empty), or false if
the sender did not specify the value (it will be empty).
|
String |
id()
The name of the index.
|
IndexStatistics |
indexStatistics()
Provides information about the number of FAQ questions and answers and the number of text documents indexed.
|
String |
name()
The name of the index.
|
String |
roleArn()
The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon
Cloudwatch logs.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeIndexResponse.Builder> |
serializableBuilderClass() |
ServerSideEncryptionConfiguration |
serverSideEncryptionConfiguration()
The identifier of the AWS KMS customer master key (CMK) used to encrypt your data.
|
IndexStatus |
status()
The current status of the index.
|
String |
statusAsString()
The current status of the index.
|
DescribeIndexResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
Instant |
updatedAt()
The Unix datetime that the index was last updated.
|
UserContextPolicy |
userContextPolicy()
The user context policy for the Amazon Kendra index.
|
String |
userContextPolicyAsString()
The user context policy for the Amazon Kendra index.
|
List<UserTokenConfiguration> |
userTokenConfigurations()
The user token configuration for the Amazon Kendra index.
|
responseMetadata
sdkHttpResponse
copy
public final String name()
The name of the index.
public final String id()
The name of the index.
public final IndexEdition edition()
The Amazon Kendra edition used for the index. You decide the edition when you create the index.
If the service returns an enum value that is not available in the current SDK version, edition
will
return IndexEdition.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
editionAsString()
.
IndexEdition
public final String editionAsString()
The Amazon Kendra edition used for the index. You decide the edition when you create the index.
If the service returns an enum value that is not available in the current SDK version, edition
will
return IndexEdition.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
editionAsString()
.
IndexEdition
public final String roleArn()
The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.
public final ServerSideEncryptionConfiguration serverSideEncryptionConfiguration()
The identifier of the AWS KMS customer master key (CMK) used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
public final IndexStatus status()
The current status of the index. When the value is ACTIVE
, the index is ready for use. If the
Status
field value is FAILED
, the ErrorMessage
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
return IndexStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusAsString()
.
ACTIVE
, the index is ready for use. If
the Status
field value is FAILED
, the ErrorMessage
field contains
a message that explains why.IndexStatus
public final String statusAsString()
The current status of the index. When the value is ACTIVE
, the index is ready for use. If the
Status
field value is FAILED
, the ErrorMessage
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
return IndexStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusAsString()
.
ACTIVE
, the index is ready for use. If
the Status
field value is FAILED
, the ErrorMessage
field contains
a message that explains why.IndexStatus
public final String description()
The description of the index.
public final Instant createdAt()
The Unix datetime that the index was created.
public final Instant updatedAt()
The Unix datetime that the index was last updated.
public final boolean hasDocumentMetadataConfigurations()
public final List<DocumentMetadataConfiguration> documentMetadataConfigurations()
Configuration settings for any metadata applied to the documents in the index.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasDocumentMetadataConfigurations()
to see if a value was sent in this field.
public final IndexStatistics indexStatistics()
Provides information about the number of FAQ questions and answers and the number of text documents indexed.
public final String errorMessage()
When th eStatus
field value is FAILED
, the ErrorMessage
field contains a
message that explains why.
Status
field value is FAILED
, the ErrorMessage
field
contains a message that explains why.public final CapacityUnitsConfiguration capacityUnits()
For enterprise edtion indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A 0 for the query capacity or the storage capacity indicates that the index is using the default capacity for the index.
public final boolean hasUserTokenConfigurations()
public final List<UserTokenConfiguration> userTokenConfigurations()
The user token configuration for the Amazon Kendra index.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasUserTokenConfigurations()
to see if a value was sent in this field.
public final UserContextPolicy userContextPolicy()
The user context policy for the Amazon Kendra index.
If the service returns an enum value that is not available in the current SDK version, userContextPolicy
will return UserContextPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from userContextPolicyAsString()
.
UserContextPolicy
public final String userContextPolicyAsString()
The user context policy for the Amazon Kendra index.
If the service returns an enum value that is not available in the current SDK version, userContextPolicy
will return UserContextPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from userContextPolicyAsString()
.
UserContextPolicy
public DescribeIndexResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeIndexResponse.Builder,DescribeIndexResponse>
toBuilder
in class AwsResponse
public static DescribeIndexResponse.Builder builder()
public static Class<? extends DescribeIndexResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. 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, the SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.