UpdateIndexRequest (AWS Java SDK :: Services

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UpdateIndexRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static UpdateIndexRequest.Builder`	`builder()`
`CapacityUnitsConfiguration`	`capacityUnits()` Sets the number of additional 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()`
`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 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.
`UserContextPolicy`	`userContextPolicy()` The user user token context policy.
`String`	`userContextPolicyAsString()` The user user token context policy.
`List<UserTokenConfiguration>`	`userTokenConfigurations()` The user token configuration.

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 final String id()
```
    The identifier of the index to update.
    
    Returns:
    
    The identifier of the index to update.
  - name
```
public final String name()
```
    The name of the index to update.
    
    Returns:
    
    The name of the index to update.
  - roleArn
```
public final 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 final String description()
```
    A new description for the index.
    
    Returns:
    
    A new description for the index.
  - hasDocumentMetadataConfigurationUpdates
```
public final 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 final 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 final CapacityUnitsConfiguration capacityUnits()
```
    Sets the number of additional 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 additional 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.
  - 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.
    
    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.
  - userContextPolicy
```
public final UserContextPolicy userContextPolicy()
```
    The user user token context policy.
    
    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 user token context policy.
    
    See Also:
    
    UserContextPolicy
  - userContextPolicyAsString
```
public final String userContextPolicyAsString()
```
    The user user token context policy.
    
    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 user token context policy.
    
    See Also:
    
    UserContextPolicy
  - 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 final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UpdateIndexRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

id

name

roleArn

description

hasDocumentMetadataConfigurationUpdates

documentMetadataConfigurationUpdates

capacityUnits

hasUserTokenConfigurations

userTokenConfigurations

userContextPolicy

userContextPolicyAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields