Class GetDataSourceResponse

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

  • Method Details

    • applicationId

      public final String applicationId()

      The identifier of the Amazon Q Business application.

      Returns:
      The identifier of the Amazon Q Business application.

    • indexId

      public final String indexId()

      The identifier of the index linked to the data source connector.

      Returns:
      The identifier of the index linked to the data source connector.

    • dataSourceId

      public final String dataSourceId()

      The identifier of the data source connector.

      Returns:
      The identifier of the data source connector.

    • dataSourceArn

      public final String dataSourceArn()

      The Amazon Resource Name (ARN) of the data source.

      Returns:
      The Amazon Resource Name (ARN) of the data source.

    • displayName

      public final String displayName()

      The name for the data source connector.

      Returns:
      The name for the data source connector.

    • type

      public final String type()

      The type of the data source connector. For example, S3.

      Returns:
      The type of the data source connector. For example, S3.

    • configuration

      public final Document configuration()

      The details of how the data source connector is configured.

      Returns:
      The details of how the data source connector is configured.

    • vpcConfiguration

      public final DataSourceVpcConfiguration vpcConfiguration()

      Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.

      Returns:
      Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.

    • 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 field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

      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 field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.
      See Also:

    • statusAsString

      public final String statusAsString()

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

      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 field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.
      See Also:

    • syncSchedule

      public final String syncSchedule()

      The schedule for Amazon Q Business to update the index.

      Returns:
      The schedule for Amazon Q Business 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.

    • error

      public final ErrorDetail error()

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

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

    • documentEnrichmentConfiguration

      public final DocumentEnrichmentConfiguration documentEnrichmentConfiguration()
      Returns the value of the DocumentEnrichmentConfiguration property for this object.
      Returns:
      The value of the DocumentEnrichmentConfiguration property for this object.

    • mediaExtractionConfiguration

      public final MediaExtractionConfiguration mediaExtractionConfiguration()

      The configuration for extracting information from media in documents for the data source.

      Returns:
      The configuration for extracting information from media in documents for the data source.

    • toBuilder

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

    • builder

      public static GetDataSourceResponse.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.