Interface ListProspectingFromEngagementTasksRequest.Builder

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

  • Method Details

    • catalog

      ListProspectingFromEngagementTasksRequest.Builder catalog(String catalog)

      Specifies the catalog to list tasks from. Specify AWS for production environments and Sandbox for testing and development purposes.

      Parameters:
      catalog - Specifies the catalog to list tasks from. Specify AWS for production environments and Sandbox for testing and development purposes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListProspectingFromEngagementTasksRequest.Builder maxResults(Integer maxResults)

      The maximum number of results to return in a single page. If additional results exist, the response includes a NextToken value for retrieving the next page. If omitted, the API uses a service-defined default page size.

      Parameters:
      maxResults - The maximum number of results to return in a single page. If additional results exist, the response includes a NextToken value for retrieving the next page. If omitted, the API uses a service-defined default page size.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListProspectingFromEngagementTasksRequest.Builder nextToken(String nextToken)

      The pagination token from a previous call to this API. Include this value to retrieve the next page of results. If omitted, the first page is returned.

      Parameters:
      nextToken - The pagination token from a previous call to this API. Include this value to retrieve the next page of results. If omitted, the first page is returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskIdentifier

      ListProspectingFromEngagementTasksRequest.Builder taskIdentifier(Collection<String> taskIdentifier)

      Filters the results to include only the tasks with the specified identifiers. Provide up to 10 task IDs to narrow the list to specific tasks. If omitted, tasks are not filtered by identifier.

      Parameters:
      taskIdentifier - Filters the results to include only the tasks with the specified identifiers. Provide up to 10 task IDs to narrow the list to specific tasks. If omitted, tasks are not filtered by identifier.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskIdentifier

      ListProspectingFromEngagementTasksRequest.Builder taskIdentifier(String... taskIdentifier)

      Filters the results to include only the tasks with the specified identifiers. Provide up to 10 task IDs to narrow the list to specific tasks. If omitted, tasks are not filtered by identifier.

      Parameters:
      taskIdentifier - Filters the results to include only the tasks with the specified identifiers. Provide up to 10 task IDs to narrow the list to specific tasks. If omitted, tasks are not filtered by identifier.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskName

      ListProspectingFromEngagementTasksRequest.Builder taskName(Collection<String> taskName)

      Filters the results to include only tasks with the specified names. Provide up to 10 task names to narrow the list. If omitted, tasks are not filtered by name.

      Parameters:
      taskName - Filters the results to include only tasks with the specified names. Provide up to 10 task names to narrow the list. If omitted, tasks are not filtered by name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskName

      ListProspectingFromEngagementTasksRequest.Builder taskName(String... taskName)

      Filters the results to include only tasks with the specified names. Provide up to 10 task names to narrow the list. If omitted, tasks are not filtered by name.

      Parameters:
      taskName - Filters the results to include only tasks with the specified names. Provide up to 10 task names to narrow the list. If omitted, tasks are not filtered by name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startAfter

      ListProspectingFromEngagementTasksRequest.Builder startAfter(Instant startAfter)

      Filters tasks to include only those that started after the specified timestamp. Use this with StartBefore to define a start-time range for your query. The format follows ISO 8601 date-time notation.

      Parameters:
      startAfter - Filters tasks to include only those that started after the specified timestamp. Use this with StartBefore to define a start-time range for your query. The format follows ISO 8601 date-time notation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startBefore

      ListProspectingFromEngagementTasksRequest.Builder startBefore(Instant startBefore)

      Filters tasks to include only those that started before the specified timestamp. Use this with StartAfter to define a start-time range for your query. The format follows ISO 8601 date-time notation.

      Parameters:
      startBefore - Filters tasks to include only those that started before the specified timestamp. Use this with StartAfter to define a start-time range for your query. The format follows ISO 8601 date-time notation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sort

      ListProspectingFromEngagementTasksRequest.Builder sort(ProspectingFromEngagementTaskSort sort)

      Specifies the field and order used to sort the returned tasks. If omitted, tasks are returned in the default sort order.

      Parameters:
      sort - Specifies the field and order used to sort the returned tasks. If omitted, tasks are returned in the default sort order.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sort

      default ListProspectingFromEngagementTasksRequest.Builder sort(Consumer<ProspectingFromEngagementTaskSort.Builder> sort)

      Specifies the field and order used to sort the returned tasks. If omitted, tasks are returned in the default sort order.

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

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

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

    • overrideConfiguration

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

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