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 additional document 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 configuration you want to update for the index.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDocumentMetadataConfigurationUpdates() For responses, this returns true if the service returned a value for the DocumentMetadataConfigurationUpdates property.
int	hashCode()
boolean	hasUserTokenConfigurations() For responses, this returns true if the service returned a value for the UserTokenConfigurations property.
String	id() The identifier of the index you want to update.
String	name() The name of the index you want to update.
String	roleArn() An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.
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 context policy.
String	userContextPolicyAsString() The user context policy.
UserGroupResolutionConfiguration	userGroupResolutionConfiguration() Enables fetching access levels of groups and users from an IAM Identity Center identity source.
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 you want to update.

Returns:

The identifier of the index you want to update.

name

public final String name()

The name of the index you want to update.

Returns:

The name of the index you want to update.

roleArn

public final String roleArn()

An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.

Returns:

An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.

description

public final String description()

A new description for the index.

Returns:

A new description for the index.

hasDocumentMetadataConfigurationUpdates

public final boolean hasDocumentMetadataConfigurationUpdates()

For responses, this returns true if the service returned a value for the DocumentMetadataConfigurationUpdates property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

documentMetadataConfigurationUpdates

public final List<DocumentMetadataConfiguration> documentMetadataConfigurationUpdates()

The document metadata configuration you want to update for the index. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.

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

Returns:

The document metadata configuration you want to update for the index. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.

capacityUnits

public final CapacityUnitsConfiguration capacityUnits()

Sets the number of additional document 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, or make 5 API calls.

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

Returns:

Sets the number of additional document 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, or make 5 API calls.

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

hasUserTokenConfigurations

public final boolean hasUserTokenConfigurations()

For responses, this returns true if the service returned a value for the UserTokenConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

userTokenConfigurations

public final List<UserTokenConfiguration> userTokenConfigurations()

The user token configuration.

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

Returns:

The user token configuration.

userContextPolicy

public final UserContextPolicy userContextPolicy()

The user 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 context policy.

See Also:

UserContextPolicy

userContextPolicyAsString

public final String userContextPolicyAsString()

The user 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 context policy.

See Also:

UserContextPolicy

userGroupResolutionConfiguration

public final UserGroupResolutionConfiguration userGroupResolutionConfiguration()

Enables fetching access levels of groups and users from an IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration.

Returns:

Enables fetching access levels of groups and users from an IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration.

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