Interface ListOpportunityFromEngagementTasksRequest.Builder

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

  • Method Details

    • maxResults

      ListOpportunityFromEngagementTasksRequest.Builder maxResults(Integer maxResults)

      Specifies the maximum number of results to return in a single page of the response. Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.

      Parameters:
      maxResults - Specifies the maximum number of results to return in a single page of the response. Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListOpportunityFromEngagementTasksRequest.Builder nextToken(String nextToken)

      The token for requesting the next page of results. This value is obtained from the NextToken field in the response of a previous call to this API. Use this parameter for pagination when the result set spans multiple pages.

      Parameters:
      nextToken - The token for requesting the next page of results. This value is obtained from the NextToken field in the response of a previous call to this API. Use this parameter for pagination when the result set spans multiple pages.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sort

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

    • sort

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

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

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

    • catalog

      ListOpportunityFromEngagementTasksRequest.Builder catalog(String catalog)

      Specifies the catalog related to the request. Valid values are AWS for production environments and Sandbox for testing or development purposes. The catalog determines which environment the task data is retrieved from.

      Parameters:
      catalog - Specifies the catalog related to the request. Valid values are AWS for production environments and Sandbox for testing or development purposes. The catalog determines which environment the task data is retrieved from.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskStatusWithStrings

      ListOpportunityFromEngagementTasksRequest.Builder taskStatusWithStrings(Collection<String> taskStatus)

      Filters the tasks based on their current status. This allows you to focus on tasks in specific states. Valid values are COMPLETE for tasks that have finished successfully, INPROGRESS for tasks that are currently running, and FAILED for tasks that have encountered an error and failed to complete.

      Parameters:
      taskStatus - Filters the tasks based on their current status. This allows you to focus on tasks in specific states. Valid values are COMPLETE for tasks that have finished successfully, INPROGRESS for tasks that are currently running, and FAILED for tasks that have encountered an error and failed to complete.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskStatusWithStrings

      ListOpportunityFromEngagementTasksRequest.Builder taskStatusWithStrings(String... taskStatus)

      Filters the tasks based on their current status. This allows you to focus on tasks in specific states. Valid values are COMPLETE for tasks that have finished successfully, INPROGRESS for tasks that are currently running, and FAILED for tasks that have encountered an error and failed to complete.

      Parameters:
      taskStatus - Filters the tasks based on their current status. This allows you to focus on tasks in specific states. Valid values are COMPLETE for tasks that have finished successfully, INPROGRESS for tasks that are currently running, and FAILED for tasks that have encountered an error and failed to complete.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskStatus

      ListOpportunityFromEngagementTasksRequest.Builder taskStatus(Collection<TaskStatus> taskStatus)

      Filters the tasks based on their current status. This allows you to focus on tasks in specific states. Valid values are COMPLETE for tasks that have finished successfully, INPROGRESS for tasks that are currently running, and FAILED for tasks that have encountered an error and failed to complete.

      Parameters:
      taskStatus - Filters the tasks based on their current status. This allows you to focus on tasks in specific states. Valid values are COMPLETE for tasks that have finished successfully, INPROGRESS for tasks that are currently running, and FAILED for tasks that have encountered an error and failed to complete.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskStatus

      ListOpportunityFromEngagementTasksRequest.Builder taskStatus(TaskStatus... taskStatus)

      Filters the tasks based on their current status. This allows you to focus on tasks in specific states. Valid values are COMPLETE for tasks that have finished successfully, INPROGRESS for tasks that are currently running, and FAILED for tasks that have encountered an error and failed to complete.

      Parameters:
      taskStatus - Filters the tasks based on their current status. This allows you to focus on tasks in specific states. Valid values are COMPLETE for tasks that have finished successfully, INPROGRESS for tasks that are currently running, and FAILED for tasks that have encountered an error and failed to complete.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskIdentifier

      ListOpportunityFromEngagementTasksRequest.Builder taskIdentifier(Collection<String> taskIdentifier)

      Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks. Provide the task ID to get details about a particular opportunity creation task.

      Parameters:
      taskIdentifier - Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks. Provide the task ID to get details about a particular opportunity creation task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskIdentifier

      ListOpportunityFromEngagementTasksRequest.Builder taskIdentifier(String... taskIdentifier)

      Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks. Provide the task ID to get details about a particular opportunity creation task.

      Parameters:
      taskIdentifier - Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks. Provide the task ID to get details about a particular opportunity creation task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • opportunityIdentifier

      ListOpportunityFromEngagementTasksRequest.Builder opportunityIdentifier(Collection<String> opportunityIdentifier)

      Filters tasks by the identifiers of the opportunities they created or are associated with. Use this to find tasks related to specific opportunity creation processes.

      Parameters:
      opportunityIdentifier - Filters tasks by the identifiers of the opportunities they created or are associated with. Use this to find tasks related to specific opportunity creation processes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • opportunityIdentifier

      ListOpportunityFromEngagementTasksRequest.Builder opportunityIdentifier(String... opportunityIdentifier)

      Filters tasks by the identifiers of the opportunities they created or are associated with. Use this to find tasks related to specific opportunity creation processes.

      Parameters:
      opportunityIdentifier - Filters tasks by the identifiers of the opportunities they created or are associated with. Use this to find tasks related to specific opportunity creation processes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engagementIdentifier

      ListOpportunityFromEngagementTasksRequest.Builder engagementIdentifier(Collection<String> engagementIdentifier)

      Filters tasks by the identifiers of the engagements from which opportunities are being created. Use this to find all opportunity creation tasks associated with a specific engagement.

      Parameters:
      engagementIdentifier - Filters tasks by the identifiers of the engagements from which opportunities are being created. Use this to find all opportunity creation tasks associated with a specific engagement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engagementIdentifier

      ListOpportunityFromEngagementTasksRequest.Builder engagementIdentifier(String... engagementIdentifier)

      Filters tasks by the identifiers of the engagements from which opportunities are being created. Use this to find all opportunity creation tasks associated with a specific engagement.

      Parameters:
      engagementIdentifier - Filters tasks by the identifiers of the engagements from which opportunities are being created. Use this to find all opportunity creation tasks associated with a specific engagement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contextIdentifier

      ListOpportunityFromEngagementTasksRequest.Builder contextIdentifier(Collection<String> contextIdentifier)

      Filters tasks by the identifiers of the engagement contexts associated with the opportunity creation. Use this to find tasks related to specific contextual information within engagements that are being converted to opportunities.

      Parameters:
      contextIdentifier - Filters tasks by the identifiers of the engagement contexts associated with the opportunity creation. Use this to find tasks related to specific contextual information within engagements that are being converted to opportunities.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contextIdentifier

      ListOpportunityFromEngagementTasksRequest.Builder contextIdentifier(String... contextIdentifier)

      Filters tasks by the identifiers of the engagement contexts associated with the opportunity creation. Use this to find tasks related to specific contextual information within engagements that are being converted to opportunities.

      Parameters:
      contextIdentifier - Filters tasks by the identifiers of the engagement contexts associated with the opportunity creation. Use this to find tasks related to specific contextual information within engagements that are being converted to opportunities.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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