Interface ListOpportunitiesRequest.Builder

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

  • Method Details

    • catalog

      ListOpportunitiesRequest.Builder catalog(String catalog)

      Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunities are listed in. Use AWS for listing real opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

      Parameters:
      catalog - Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunities are listed in. Use AWS for listing real opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListOpportunitiesRequest.Builder maxResults(Integer maxResults)

      Specifies the maximum number of results to return in a single call. This limits the number of opportunities returned in the response to avoid providing too many results at once.

      Default: 20

      Parameters:
      maxResults - Specifies the maximum number of results to return in a single call. This limits the number of opportunities returned in the response to avoid providing too many results at once.

      Default: 20

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListOpportunitiesRequest.Builder nextToken(String nextToken)

      A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.

      Parameters:
      nextToken - A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sort

      ListOpportunitiesRequest.Builder sort(OpportunitySort sort)

      An object that specifies how the response is sorted. The default Sort.SortBy value is LastModifiedDate.

      Parameters:
      sort - An object that specifies how the response is sorted. The default Sort.SortBy value is LastModifiedDate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sort

      default ListOpportunitiesRequest.Builder sort(Consumer<OpportunitySort.Builder> sort)

      An object that specifies how the response is sorted. The default Sort.SortBy value is LastModifiedDate.

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

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

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

    • lastModifiedDate

      ListOpportunitiesRequest.Builder lastModifiedDate(LastModifiedDate lastModifiedDate)

      Filters the opportunities based on their last modified date. This filter helps retrieve opportunities that were updated after the specified date, allowing partners to track recent changes or updates.

      Parameters:
      lastModifiedDate - Filters the opportunities based on their last modified date. This filter helps retrieve opportunities that were updated after the specified date, allowing partners to track recent changes or updates.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastModifiedDate

      default ListOpportunitiesRequest.Builder lastModifiedDate(Consumer<LastModifiedDate.Builder> lastModifiedDate)

      Filters the opportunities based on their last modified date. This filter helps retrieve opportunities that were updated after the specified date, allowing partners to track recent changes or updates.

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

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

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

    • identifier

      ListOpportunitiesRequest.Builder identifier(Collection<String> identifier)

      Filters the opportunities based on the opportunity identifier. This allows partners to retrieve specific opportunities by providing their unique identifiers, ensuring precise results.

      Parameters:
      identifier - Filters the opportunities based on the opportunity identifier. This allows partners to retrieve specific opportunities by providing their unique identifiers, ensuring precise results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identifier

      ListOpportunitiesRequest.Builder identifier(String... identifier)

      Filters the opportunities based on the opportunity identifier. This allows partners to retrieve specific opportunities by providing their unique identifiers, ensuring precise results.

      Parameters:
      identifier - Filters the opportunities based on the opportunity identifier. This allows partners to retrieve specific opportunities by providing their unique identifiers, ensuring precise results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lifeCycleStageWithStrings

      ListOpportunitiesRequest.Builder lifeCycleStageWithStrings(Collection<String> lifeCycleStage)

      Filters the opportunities based on their lifecycle stage. This filter allows partners to retrieve opportunities at various stages in the sales cycle, such as Qualified, Technical Validation, Business Validation, or Closed Won.

      Parameters:
      lifeCycleStage - Filters the opportunities based on their lifecycle stage. This filter allows partners to retrieve opportunities at various stages in the sales cycle, such as Qualified, Technical Validation, Business Validation, or Closed Won.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lifeCycleStageWithStrings

      ListOpportunitiesRequest.Builder lifeCycleStageWithStrings(String... lifeCycleStage)

      Filters the opportunities based on their lifecycle stage. This filter allows partners to retrieve opportunities at various stages in the sales cycle, such as Qualified, Technical Validation, Business Validation, or Closed Won.

      Parameters:
      lifeCycleStage - Filters the opportunities based on their lifecycle stage. This filter allows partners to retrieve opportunities at various stages in the sales cycle, such as Qualified, Technical Validation, Business Validation, or Closed Won.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lifeCycleStage

      ListOpportunitiesRequest.Builder lifeCycleStage(Collection<Stage> lifeCycleStage)

      Filters the opportunities based on their lifecycle stage. This filter allows partners to retrieve opportunities at various stages in the sales cycle, such as Qualified, Technical Validation, Business Validation, or Closed Won.

      Parameters:
      lifeCycleStage - Filters the opportunities based on their lifecycle stage. This filter allows partners to retrieve opportunities at various stages in the sales cycle, such as Qualified, Technical Validation, Business Validation, or Closed Won.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lifeCycleStage

      ListOpportunitiesRequest.Builder lifeCycleStage(Stage... lifeCycleStage)

      Filters the opportunities based on their lifecycle stage. This filter allows partners to retrieve opportunities at various stages in the sales cycle, such as Qualified, Technical Validation, Business Validation, or Closed Won.

      Parameters:
      lifeCycleStage - Filters the opportunities based on their lifecycle stage. This filter allows partners to retrieve opportunities at various stages in the sales cycle, such as Qualified, Technical Validation, Business Validation, or Closed Won.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lifeCycleReviewStatusWithStrings

      ListOpportunitiesRequest.Builder lifeCycleReviewStatusWithStrings(Collection<String> lifeCycleReviewStatus)

      Filters the opportunities based on their current lifecycle approval status. Use this filter to retrieve opportunities with statuses such as Pending Submission, In Review, Action Required, or Approved.

      Parameters:
      lifeCycleReviewStatus - Filters the opportunities based on their current lifecycle approval status. Use this filter to retrieve opportunities with statuses such as Pending Submission, In Review, Action Required, or Approved.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lifeCycleReviewStatusWithStrings

      ListOpportunitiesRequest.Builder lifeCycleReviewStatusWithStrings(String... lifeCycleReviewStatus)

      Filters the opportunities based on their current lifecycle approval status. Use this filter to retrieve opportunities with statuses such as Pending Submission, In Review, Action Required, or Approved.

      Parameters:
      lifeCycleReviewStatus - Filters the opportunities based on their current lifecycle approval status. Use this filter to retrieve opportunities with statuses such as Pending Submission, In Review, Action Required, or Approved.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lifeCycleReviewStatus

      ListOpportunitiesRequest.Builder lifeCycleReviewStatus(Collection<ReviewStatus> lifeCycleReviewStatus)

      Filters the opportunities based on their current lifecycle approval status. Use this filter to retrieve opportunities with statuses such as Pending Submission, In Review, Action Required, or Approved.

      Parameters:
      lifeCycleReviewStatus - Filters the opportunities based on their current lifecycle approval status. Use this filter to retrieve opportunities with statuses such as Pending Submission, In Review, Action Required, or Approved.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lifeCycleReviewStatus

      ListOpportunitiesRequest.Builder lifeCycleReviewStatus(ReviewStatus... lifeCycleReviewStatus)

      Filters the opportunities based on their current lifecycle approval status. Use this filter to retrieve opportunities with statuses such as Pending Submission, In Review, Action Required, or Approved.

      Parameters:
      lifeCycleReviewStatus - Filters the opportunities based on their current lifecycle approval status. Use this filter to retrieve opportunities with statuses such as Pending Submission, In Review, Action Required, or Approved.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customerCompanyName

      ListOpportunitiesRequest.Builder customerCompanyName(Collection<String> customerCompanyName)

      Filters the opportunities based on the customer's company name. This allows partners to search for opportunities associated with a specific customer by matching the provided company name string.

      Parameters:
      customerCompanyName - Filters the opportunities based on the customer's company name. This allows partners to search for opportunities associated with a specific customer by matching the provided company name string.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customerCompanyName

      ListOpportunitiesRequest.Builder customerCompanyName(String... customerCompanyName)

      Filters the opportunities based on the customer's company name. This allows partners to search for opportunities associated with a specific customer by matching the provided company name string.

      Parameters:
      customerCompanyName - Filters the opportunities based on the customer's company name. This allows partners to search for opportunities associated with a specific customer by matching the provided company name string.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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