Interface ListCampaignsRequest.Builder

  • Method Details

    • catalog

      The catalog (AWS or Sandbox).

      Parameters:
      catalog - The catalog (AWS or Sandbox).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • catalog

      The catalog (AWS or Sandbox).

      Parameters:
      catalog - The catalog (AWS or Sandbox).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • campaignIdentifiers

      ListCampaignsRequest.Builder campaignIdentifiers(Collection<String> campaignIdentifiers)

      Only these campaigns, each named by its id or its campaign ARN. A campaign that does not exist, was deleted, or whose ARN names another account or catalog is left out rather than refused.

      Parameters:
      campaignIdentifiers - Only these campaigns, each named by its id or its campaign ARN. A campaign that does not exist, was deleted, or whose ARN names another account or catalog is left out rather than refused.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • campaignIdentifiers

      ListCampaignsRequest.Builder campaignIdentifiers(String... campaignIdentifiers)

      Only these campaigns, each named by its id or its campaign ARN. A campaign that does not exist, was deleted, or whose ARN names another account or catalog is left out rather than refused.

      Parameters:
      campaignIdentifiers - Only these campaigns, each named by its id or its campaign ARN. A campaign that does not exist, was deleted, or whose ARN names another account or catalog is left out rather than refused.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • name

      Only campaigns whose name contains this, compared case-insensitively.

      Parameters:
      name - Only campaigns whose name contains this, compared case-insensitively.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • statesWithStrings

      ListCampaignsRequest.Builder statesWithStrings(Collection<String> states)

      Only campaigns in one of these states.

      Parameters:
      states - Only campaigns in one of these states.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • statesWithStrings

      ListCampaignsRequest.Builder statesWithStrings(String... states)

      Only campaigns in one of these states.

      Parameters:
      states - Only campaigns in one of these states.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • states

      Only campaigns in one of these states.

      Parameters:
      states - Only campaigns in one of these states.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • states

      Only campaigns in one of these states.

      Parameters:
      states - Only campaigns in one of these states.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • sort

      The order of the results. Default: CREATED_AT, DESCENDING.

      Parameters:
      sort - The order of the results. Default: CREATED_AT, DESCENDING.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • sort

      The order of the results. Default: CREATED_AT, DESCENDING.

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

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

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

      ListCampaignsRequest.Builder maxResults(Integer maxResults)

      Maximum results per page.

      Parameters:
      maxResults - Maximum results per page.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • nextToken

      ListCampaignsRequest.Builder nextToken(String nextToken)

      Pagination token. Bound to the filters and sort it was issued for: a request that changes CampaignIdentifiers, Name, States or Sort between pages is refused with ValidationException. MaxResults may change.

      Parameters:
      nextToken - Pagination token. Bound to the filters and sort it was issued for: a request that changes CampaignIdentifiers, Name, States or Sort between pages is refused with ValidationException. MaxResults may change.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • overrideConfiguration

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

      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.