Interface ListDataSourceSyncJobsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListDataSourceSyncJobsRequest.Builder,ListDataSourceSyncJobsRequest>, KendraRequest.Builder, SdkBuilder<ListDataSourceSyncJobsRequest.Builder,ListDataSourceSyncJobsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListDataSourceSyncJobsRequest
@Mutable @NotThreadSafe public static interface ListDataSourceSyncJobsRequest.Builder extends KendraRequest.Builder, SdkPojo, CopyableBuilder<ListDataSourceSyncJobsRequest.Builder,ListDataSourceSyncJobsRequest>

  • Method Details

    • id

      ListDataSourceSyncJobsRequest.Builder id(String id)

      The identifier of the data source connector.

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

    • indexId

      ListDataSourceSyncJobsRequest.Builder indexId(String indexId)

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

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

    • nextToken

      ListDataSourceSyncJobsRequest.Builder nextToken(String nextToken)

      If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of jobs.

      Parameters:
      nextToken - If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of jobs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListDataSourceSyncJobsRequest.Builder maxResults(Integer maxResults)

      The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

      Parameters:
      maxResults - The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTimeFilter

      ListDataSourceSyncJobsRequest.Builder startTimeFilter(TimeRange startTimeFilter)

      When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

      Parameters:
      startTimeFilter - When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTimeFilter

      default ListDataSourceSyncJobsRequest.Builder startTimeFilter(Consumer<TimeRange.Builder> startTimeFilter)

      When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

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

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

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

    • statusFilter

      ListDataSourceSyncJobsRequest.Builder statusFilter(String statusFilter)

      Only returns synchronization jobs with the Status field equal to the specified status.

      Parameters:
      statusFilter - Only returns synchronization jobs with the Status field equal to the specified status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusFilter

      ListDataSourceSyncJobsRequest.Builder statusFilter(DataSourceSyncJobStatus statusFilter)

      Only returns synchronization jobs with the Status field equal to the specified status.

      Parameters:
      statusFilter - Only returns synchronization jobs with the Status field equal to the specified status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      ListDataSourceSyncJobsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListDataSourceSyncJobsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.