software.amazon.awssdk.services.kendra.model

Class UpdateIndexRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kendra.model.KendraRequest

software.amazon.awssdk.services.kendra.model.UpdateIndexRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateIndexRequest.Builder,UpdateIndexRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateIndexRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateIndexRequest.Builder	builder()
CapacityUnitsConfiguration	capacityUnits() Sets the number of addtional storage and query capacity units that should be used by the index.
String	description() A new description for the index.
List<DocumentMetadataConfiguration>	documentMetadataConfigurationUpdates() The document metadata to update.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDocumentMetadataConfigurationUpdates() Returns true if the DocumentMetadataConfigurationUpdates 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()
String	id() The identifier of the index to update.
String	name() The name of the index to update.
String	roleArn() A new IAM role that gives Amazon Kendra permission to access your Amazon CloudWatch logs.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateIndexRequest.Builder>	serializableBuilderClass()
UpdateIndexRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

id

public String id()

The identifier of the index to update.

Returns:

The identifier of the index to update.

name

public String name()

The name of the index to update.

Returns:

The name of the index to update.

roleArn

public String roleArn()

A new IAM role that gives Amazon Kendra permission to access your Amazon CloudWatch logs.

Returns:

A new IAM role that gives Amazon Kendra permission to access your Amazon CloudWatch logs.

description

public String description()

A new description for the index.

Returns:

A new description for the index.

hasDocumentMetadataConfigurationUpdates

public boolean hasDocumentMetadataConfigurationUpdates()

Returns true if the DocumentMetadataConfigurationUpdates 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.

documentMetadataConfigurationUpdates

public List<DocumentMetadataConfiguration> documentMetadataConfigurationUpdates()

The document metadata to update.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasDocumentMetadataConfigurationUpdates() to see if a value was sent in this field.

Returns:

The document metadata to update.

capacityUnits

public CapacityUnitsConfiguration capacityUnits()

Sets the number of addtional storage and query capacity units that should be used by the index. You can change the capacity of the index up to 5 times per day.

If you are using extra storage units, you can't reduce the storage capacity below that required to meet the storage needs for your index.

Returns:

Sets the number of addtional storage and query capacity units that should be used by the index. You can change the capacity of the index up to 5 times per day.

If you are using extra storage units, you can't reduce the storage capacity below that required to meet the storage needs for your index.

toBuilder

public UpdateIndexRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateIndexRequest.Builder,UpdateIndexRequest>

Specified by:

toBuilder in class KendraRequest

builder

public static UpdateIndexRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo