Interface GetDataSourceResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetDataSourceResponse.Builder,GetDataSourceResponse>, QBusinessResponse.Builder, SdkBuilder<GetDataSourceResponse.Builder,GetDataSourceResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetDataSourceResponse
@Mutable @NotThreadSafe public static interface GetDataSourceResponse.Builder extends QBusinessResponse.Builder, SdkPojo, CopyableBuilder<GetDataSourceResponse.Builder,GetDataSourceResponse>

  • Method Details

    • applicationId

      GetDataSourceResponse.Builder applicationId(String applicationId)

      The identifier of the Amazon Q Business application.

      Parameters:
      applicationId - The identifier of the Amazon Q Business application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • indexId

      GetDataSourceResponse.Builder indexId(String indexId)

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

      Parameters:
      indexId - The identifier of the index linked to the data source connector.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSourceId

      GetDataSourceResponse.Builder dataSourceId(String dataSourceId)

      The identifier of the data source connector.

      Parameters:
      dataSourceId - The identifier of the data source connector.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSourceArn

      GetDataSourceResponse.Builder dataSourceArn(String dataSourceArn)

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

      Parameters:
      dataSourceArn - The Amazon Resource Name (ARN) of the data source.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • displayName

      GetDataSourceResponse.Builder displayName(String displayName)

      The name for the data source connector.

      Parameters:
      displayName - The name for the data source connector.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      GetDataSourceResponse.Builder type(String type)

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

      Parameters:
      type - The type of the data source connector. For example, S3.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configuration

      GetDataSourceResponse.Builder configuration(Document configuration)

      The details of how the data source connector is configured.

      Parameters:
      configuration - The details of how the data source connector is configured.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfiguration

      GetDataSourceResponse.Builder vpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)

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

      Parameters:
      vpcConfiguration - Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfiguration

      default GetDataSourceResponse.Builder vpcConfiguration(Consumer<DataSourceVpcConfiguration.Builder> vpcConfiguration)

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

      This is a convenience method that creates an instance of the DataSourceVpcConfiguration.Builder avoiding the need to create one manually via DataSourceVpcConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfiguration(DataSourceVpcConfiguration).

      Parameters:
      vpcConfiguration - a consumer that will call methods on DataSourceVpcConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdAt

      GetDataSourceResponse.Builder createdAt(Instant createdAt)

      The Unix timestamp when the data source connector was created.

      Parameters:
      createdAt - The Unix timestamp when the data source connector was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      GetDataSourceResponse.Builder updatedAt(Instant updatedAt)

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

      Parameters:
      updatedAt - The Unix timestamp when the data source connector was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      GetDataSourceResponse.Builder description(String description)

      The description for the data source connector.

      Parameters:
      description - The description for the data source connector.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      GetDataSourceResponse.Builder status(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      GetDataSourceResponse.Builder status(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • syncSchedule

      GetDataSourceResponse.Builder syncSchedule(String syncSchedule)

      The schedule for Amazon Q Business to update the index.

      Parameters:
      syncSchedule - The schedule for Amazon Q Business to update the index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      GetDataSourceResponse.Builder roleArn(String roleArn)

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

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • error

      GetDataSourceResponse.Builder error(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • error

      default GetDataSourceResponse.Builder error(Consumer<ErrorDetail.Builder> 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.

      This is a convenience method that creates an instance of the ErrorDetail.Builder avoiding the need to create one manually via ErrorDetail.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to error(ErrorDetail).

      Parameters:
      error - a consumer that will call methods on ErrorDetail.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • documentEnrichmentConfiguration

      GetDataSourceResponse.Builder documentEnrichmentConfiguration(DocumentEnrichmentConfiguration documentEnrichmentConfiguration)
      Sets the value of the DocumentEnrichmentConfiguration property for this object.
      Parameters:
      documentEnrichmentConfiguration - The new value for the DocumentEnrichmentConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentEnrichmentConfiguration

      default GetDataSourceResponse.Builder documentEnrichmentConfiguration(Consumer<DocumentEnrichmentConfiguration.Builder> documentEnrichmentConfiguration)
      Sets the value of the DocumentEnrichmentConfiguration property for this object. This is a convenience method that creates an instance of the DocumentEnrichmentConfiguration.Builder avoiding the need to create one manually via DocumentEnrichmentConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentEnrichmentConfiguration(DocumentEnrichmentConfiguration).

      Parameters:
      documentEnrichmentConfiguration - a consumer that will call methods on DocumentEnrichmentConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • mediaExtractionConfiguration

      GetDataSourceResponse.Builder mediaExtractionConfiguration(MediaExtractionConfiguration mediaExtractionConfiguration)

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

      Parameters:
      mediaExtractionConfiguration - The configuration for extracting information from media in documents for the data source.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mediaExtractionConfiguration

      default GetDataSourceResponse.Builder mediaExtractionConfiguration(Consumer<MediaExtractionConfiguration.Builder> mediaExtractionConfiguration)

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

      This is a convenience method that creates an instance of the MediaExtractionConfiguration.Builder avoiding the need to create one manually via MediaExtractionConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to mediaExtractionConfiguration(MediaExtractionConfiguration).

      Parameters:
      mediaExtractionConfiguration - a consumer that will call methods on MediaExtractionConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: