software.amazon.awssdk.services.kendra.model

Class DescribeIndexResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.kendra.model.KendraResponse

software.amazon.awssdk.services.kendra.model.DescribeIndexResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeIndexResponse.Builder,DescribeIndexResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeIndexResponse
extends KendraResponse
implements ToCopyableBuilder<DescribeIndexResponse.Builder,DescribeIndexResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeIndexResponse.Builder

Method Summary

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 eStatus 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.

Methods inherited from class software.amazon.awssdk.services.kendra.model.KendraResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

The name of the index.

Returns:

The name of the index.

id

public final String id()

The name of the index.

Returns:

The name of the index.

edition

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().

Returns:

The Amazon Kendra edition used for the index. You decide the edition when you create the index.

See Also:

IndexEdition

editionAsString

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().

Returns:

The Amazon Kendra edition used for the index. You decide the edition when you create the index.

See Also:

IndexEdition

roleArn

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.

Returns:

The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.

serverSideEncryptionConfiguration

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.

Returns:

The identifier of the AWS KMS customer master key (CMK) used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.

status

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().

Returns:

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.

See Also:

IndexStatus

statusAsString

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().

Returns:

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.

See Also:

IndexStatus

description

public final String description()

The description of the index.

Returns:

The description of the index.

createdAt

public final Instant createdAt()

The Unix datetime that the index was created.

Returns:

The Unix datetime that the index was created.

updatedAt

public final Instant updatedAt()

The Unix datetime that the index was last updated.

Returns:

The Unix datetime that the index was last updated.

hasDocumentMetadataConfigurations

public final 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). For responses returned by the SDK, the sender is the AWS service.

documentMetadataConfigurations

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.

Returns:

Configuration settings for any metadata applied to the documents in the index.

indexStatistics

public final IndexStatistics indexStatistics()

Provides information about the number of FAQ questions and answers and the number of text documents indexed.

Returns:

Provides information about the number of FAQ questions and answers and the number of text documents indexed.

errorMessage

public final String errorMessage()

When th eStatus field value is FAILED, the ErrorMessage field contains a message that explains why.

Returns:

When th eStatus field value is FAILED, the ErrorMessage field contains a message that explains why.

capacityUnits

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.

Returns:

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.

hasUserTokenConfigurations

public final 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). For responses returned by the SDK, the sender is the AWS service.

userTokenConfigurations

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.

Returns:

The user token configuration for the Amazon Kendra index.

userContextPolicy

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().

Returns:

The user context policy for the Amazon Kendra index.

See Also:

UserContextPolicy

userContextPolicyAsString

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().

Returns:

The user context policy for the Amazon Kendra index.

See Also:

UserContextPolicy

toBuilder

public DescribeIndexResponse.Builder 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 interface ToCopyableBuilder<DescribeIndexResponse.Builder,DescribeIndexResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeIndexResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeIndexResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

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 an 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.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkResponse

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

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.