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

Class DescribeDataSourceResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.kendra.model.KendraResponse
software.amazon.awssdk.services.kendra.model.DescribeDataSourceResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeDataSourceResponse.Builder,DescribeDataSourceResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeDataSourceResponse extends KendraResponse implements ToCopyableBuilder<DescribeDataSourceResponse.Builder,DescribeDataSourceResponse>

  • Method Details

    • id

      public final String id()

      The identifier of the data source connector.

      Returns:
      The identifier of 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.

    • name

      public final String name()

      The name for the data source connector.

      Returns:
      The name for the data source connector.

    • type

      public final DataSourceType type()

      The type of the data source. For example, SHAREPOINT.

      If the service returns an enum value that is not available in the current SDK version, type will return DataSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of the data source. For example, SHAREPOINT.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the data source. For example, SHAREPOINT.

      If the service returns an enum value that is not available in the current SDK version, type will return DataSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of the data source. For example, SHAREPOINT.
      See Also:

    • configuration

      public final DataSourceConfiguration configuration()

      Configuration details for the data source connector. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.

      Returns:
      Configuration details for the data source connector. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.

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

    • createdAt

      public final Instant createdAt()

      The Unix timestamp when the data source connector was created.

      Returns:
      The Unix timestamp when the data source connector was created.

    • updatedAt

      public final Instant updatedAt()

      The Unix timestamp when the data source connector was last updated.

      Returns:
      The Unix timestamp when the data source connector was last updated.

    • description

      public final String description()

      The description for the data source connector.

      Returns:
      The description for the data source connector.

    • status

      public final DataSourceStatus status()

      The current status of the data source connector. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source failed.

      If the service returns an enum value that is not available in the current SDK version, status will return DataSourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the data source connector. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source failed.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the data source connector. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source failed.

      If the service returns an enum value that is not available in the current SDK version, status will return DataSourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the data source connector. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source failed.
      See Also:

    • schedule

      public final String schedule()

      The schedule for Amazon Kendra to update the index.

      Returns:
      The schedule for Amazon Kendra to update the index.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.

      Returns:
      The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.

    • errorMessage

      public final String errorMessage()

      When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.

      Returns:
      When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.

    • languageCode

      public final String languageCode()

      The code for a language. This shows a supported language for all documents in 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. This shows a supported language for all documents in 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 for altering document metadata and content during the document ingestion process when you describe a data source.

      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 for altering document metadata and content during the document ingestion process when you describe a data source.

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

    • builder

      public static DescribeDataSourceResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeDataSourceResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

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