Interface ListEngagementFromOpportunityTasksRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<ListEngagementFromOpportunityTasksRequest.Builder,ListEngagementFromOpportunityTasksRequest>,PartnerCentralSellingRequest.Builder,SdkBuilder<ListEngagementFromOpportunityTasksRequest.Builder,ListEngagementFromOpportunityTasksRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- ListEngagementFromOpportunityTasksRequest
public static interface ListEngagementFromOpportunityTasksRequest.Builder extends PartnerCentralSellingRequest.Builder, SdkPojo, CopyableBuilder<ListEngagementFromOpportunityTasksRequest.Builder,ListEngagementFromOpportunityTasksRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description ListEngagementFromOpportunityTasksRequest.Buildercatalog(String catalog)Specifies the catalog related to the request.ListEngagementFromOpportunityTasksRequest.BuilderengagementIdentifier(String... engagementIdentifier)Filters tasks by the identifiers of the engagements they created or are associated with.ListEngagementFromOpportunityTasksRequest.BuilderengagementIdentifier(Collection<String> engagementIdentifier)Filters tasks by the identifiers of the engagements they created or are associated with.ListEngagementFromOpportunityTasksRequest.BuildermaxResults(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.ListEngagementFromOpportunityTasksRequest.BuildernextToken(String nextToken)The token for requesting the next page of results.ListEngagementFromOpportunityTasksRequest.BuilderopportunityIdentifier(String... opportunityIdentifier)The identifier of the original opportunity associated with this task.ListEngagementFromOpportunityTasksRequest.BuilderopportunityIdentifier(Collection<String> opportunityIdentifier)The identifier of the original opportunity associated with this task.ListEngagementFromOpportunityTasksRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)ListEngagementFromOpportunityTasksRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)default ListEngagementFromOpportunityTasksRequest.Buildersort(Consumer<ListTasksSortBase.Builder> sort)Specifies the sorting criteria for the returned results.ListEngagementFromOpportunityTasksRequest.Buildersort(ListTasksSortBase sort)Specifies the sorting criteria for the returned results.ListEngagementFromOpportunityTasksRequest.BuildertaskIdentifier(String... taskIdentifier)Filters tasks by their unique identifiers.ListEngagementFromOpportunityTasksRequest.BuildertaskIdentifier(Collection<String> taskIdentifier)Filters tasks by their unique identifiers.ListEngagementFromOpportunityTasksRequest.BuildertaskStatus(Collection<TaskStatus> taskStatus)Filters the tasks based on their current status.ListEngagementFromOpportunityTasksRequest.BuildertaskStatus(TaskStatus... taskStatus)Filters the tasks based on their current status.ListEngagementFromOpportunityTasksRequest.BuildertaskStatusWithStrings(String... taskStatus)Filters the tasks based on their current status.ListEngagementFromOpportunityTasksRequest.BuildertaskStatusWithStrings(Collection<String> taskStatus)Filters the tasks based on their current status.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.partnercentralselling.model.PartnerCentralSellingRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
catalog
ListEngagementFromOpportunityTasksRequest.Builder catalog(String catalog)
Specifies the catalog related to the request. Valid values are:
-
AWS: Retrieves the request from the production AWS environment.
-
Sandbox: Retrieves the request from a sandbox environment used for testing or development purposes.
- Parameters:
catalog- Specifies the catalog related to the request. Valid values are:-
AWS: Retrieves the request from the production AWS environment.
-
Sandbox: Retrieves the request from a sandbox environment used for testing or development purposes.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
engagementIdentifier
ListEngagementFromOpportunityTasksRequest.Builder engagementIdentifier(Collection<String> engagementIdentifier)
Filters tasks by the identifiers of the engagements they created or are associated with.
- Parameters:
engagementIdentifier- Filters tasks by the identifiers of the engagements they created or are associated with.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engagementIdentifier
ListEngagementFromOpportunityTasksRequest.Builder engagementIdentifier(String... engagementIdentifier)
Filters tasks by the identifiers of the engagements they created or are associated with.
- Parameters:
engagementIdentifier- Filters tasks by the identifiers of the engagements they created or are associated with.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
ListEngagementFromOpportunityTasksRequest.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
ListEngagementFromOpportunityTasksRequest.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.
-
opportunityIdentifier
ListEngagementFromOpportunityTasksRequest.Builder opportunityIdentifier(Collection<String> opportunityIdentifier)
The identifier of the original opportunity associated with this task.
- Parameters:
opportunityIdentifier- The identifier of the original opportunity associated with this task.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
opportunityIdentifier
ListEngagementFromOpportunityTasksRequest.Builder opportunityIdentifier(String... opportunityIdentifier)
The identifier of the original opportunity associated with this task.
- Parameters:
opportunityIdentifier- The identifier of the original opportunity associated with this task.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sort
ListEngagementFromOpportunityTasksRequest.Builder sort(ListTasksSortBase sort)
Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.
- Parameters:
sort- Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sort
default ListEngagementFromOpportunityTasksRequest.Builder sort(Consumer<ListTasksSortBase.Builder> sort)
Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.
This is a convenience method that creates an instance of theListTasksSortBase.Builderavoiding the need to create one manually viaListTasksSortBase.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosort(ListTasksSortBase).- Parameters:
sort- a consumer that will call methods onListTasksSortBase.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
sort(ListTasksSortBase)
-
taskIdentifier
ListEngagementFromOpportunityTasksRequest.Builder taskIdentifier(Collection<String> taskIdentifier)
Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.
- Parameters:
taskIdentifier- Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
taskIdentifier
ListEngagementFromOpportunityTasksRequest.Builder taskIdentifier(String... taskIdentifier)
Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.
- Parameters:
taskIdentifier- Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
taskStatusWithStrings
ListEngagementFromOpportunityTasksRequest.Builder taskStatusWithStrings(Collection<String> taskStatus)
Filters the tasks based on their current status. This allows you to focus on tasks in specific states.
- Parameters:
taskStatus- Filters the tasks based on their current status. This allows you to focus on tasks in specific states.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
taskStatusWithStrings
ListEngagementFromOpportunityTasksRequest.Builder taskStatusWithStrings(String... taskStatus)
Filters the tasks based on their current status. This allows you to focus on tasks in specific states.
- Parameters:
taskStatus- Filters the tasks based on their current status. This allows you to focus on tasks in specific states.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
taskStatus
ListEngagementFromOpportunityTasksRequest.Builder taskStatus(Collection<TaskStatus> taskStatus)
Filters the tasks based on their current status. This allows you to focus on tasks in specific states.
- Parameters:
taskStatus- Filters the tasks based on their current status. This allows you to focus on tasks in specific states.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
taskStatus
ListEngagementFromOpportunityTasksRequest.Builder taskStatus(TaskStatus... taskStatus)
Filters the tasks based on their current status. This allows you to focus on tasks in specific states.
- Parameters:
taskStatus- Filters the tasks based on their current status. This allows you to focus on tasks in specific states.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListEngagementFromOpportunityTasksRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
ListEngagementFromOpportunityTasksRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-