Package software.amazon.awssdk.services.kendra.model

Class UpdateDataSourceRequest

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.UpdateDataSourceRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateDataSourceRequest.Builder,UpdateDataSourceRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateDataSourceRequest extends KendraRequest implements ToCopyableBuilder<UpdateDataSourceRequest.Builder,UpdateDataSourceRequest>

  • Method Details

    • id

      public final String id()

      The identifier of the data source connector you want to update.

      Returns:
      The identifier of the data source connector you want to update.

    • name

      public final String name()

      A new name for the data source connector.

      Returns:
      A new name for the data source connector.

    • indexId

      public final String indexId()

      The identifier of the index used with the data source connector.

      Returns:
      The identifier of the index used with the data source connector.

    • configuration

      public final DataSourceConfiguration configuration()

      Configuration information you want to update for the data source connector.

      Returns:
      Configuration information you want to update for the data source connector.

    • vpcConfiguration

      public final DataSourceVpcConfiguration vpcConfiguration()

      Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

      Returns:
      Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

    • description

      public final String description()

      A new description for the data source connector.

      Returns:
      A new description for the data source connector.

    • schedule

      public final String schedule()

      The sync schedule you want to update for the data source connector.

      Returns:
      The sync schedule you want to update for the data source connector.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of a role with permission to access the data source and required resources. For more information, see IAM roles for Amazon Kendra.

      Returns:
      The Amazon Resource Name (ARN) of a role with permission to access the data source and required resources. For more information, see IAM roles for Amazon Kendra.

    • languageCode

      public final String languageCode()

      The code for a language you want to update for the data source connector. This allows you to support a language for all documents when updating the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

      Returns:
      The code for a language you want to update for the data source connector. This allows you to support a language for all documents when updating the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

    • customDocumentEnrichmentConfiguration

      public final CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration()

      Configuration information you want to update for altering document metadata and content during the document ingestion process.

      For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

      Returns:
      Configuration information you want to update for altering document metadata and content during the document ingestion process.

      For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

    • toBuilder

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

    • builder

      public static UpdateDataSourceRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateDataSourceRequest.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.