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("software.amazon.awssdk:codegen") public final class UpdateIndexRequest extends KendraRequest implements ToCopyableBuilder<UpdateIndexRequest.Builder,UpdateIndexRequest>

  • Method Details

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

      A new name for the index.

      Returns:
      A new name for the index.

    • 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:

    • 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:

    • userGroupResolutionConfiguration

      public final UserGroupResolutionConfiguration 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

      public UpdateIndexRequest.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<UpdateIndexRequest.Builder,UpdateIndexRequest>
      Specified by:
      toBuilder in class KendraRequest
      Returns:
      a builder for type T

    • 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)
      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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.