Class UpdateIndexRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateIndexRequest.Builder,
UpdateIndexRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic UpdateIndexRequest.Builder
builder()
Sets the number of additional document storage and query capacity units that should be used by the index.final String
A new description for the index.The document metadata configuration you want to update for the index.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the DocumentMetadataConfigurationUpdates property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the UserTokenConfigurations property.final String
id()
The identifier of the index you want to update.final String
name()
A new name for the index.final String
roleArn()
An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.static Class
<? extends UpdateIndexRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final UserContextPolicy
The user context policy.final String
The user context policy.Gets users and groups from IAM Identity Center identity source.final List
<UserTokenConfiguration> The user token configuration.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The identifier of the index you want to update.
- Returns:
- The identifier of the index you want to update.
-
name
A new name for the index.
- Returns:
- A new name for the index.
-
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
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 theisEmpty()
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
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
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 theisEmpty()
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
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
The user context policy.
If the service returns an enum value that is not available in the current SDK version,
userContextPolicy
will returnUserContextPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromuserContextPolicyAsString()
.- Returns:
- The user context policy.
- See Also:
-
userContextPolicyAsString
The user context policy.
If the service returns an enum value that is not available in the current SDK version,
userContextPolicy
will returnUserContextPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromuserContextPolicyAsString()
.- Returns:
- The user context policy.
- See Also:
-
userGroupResolutionConfiguration
Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
- Returns:
- Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
-
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 interfaceToCopyableBuilder<UpdateIndexRequest.Builder,
UpdateIndexRequest> - Specified by:
toBuilder
in classKendraRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-