Interface ListCampaignsRequest.Builder

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

  • Method Details

    • nextToken

      ListCampaignsRequest.Builder nextToken(String nextToken)

      A pagination token for the next set of results.

      If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

      Parameters:
      nextToken - A pagination token for the next set of results.

      If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

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

    • maxResults

      ListCampaignsRequest.Builder maxResults(Integer maxResults)

      The maximum number of items to return, between 1 and 100, inclusive.

      Parameters:
      maxResults - The maximum number of items to return, between 1 and 100, inclusive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      ListCampaignsRequest.Builder status(String status)

      An optional parameter to filter the results by the status of each created campaign in your account. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, or SUSPENDED.

      Parameters:
      status - An optional parameter to filter the results by the status of each created campaign in your account. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, or SUSPENDED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • listResponseScope

      ListCampaignsRequest.Builder listResponseScope(String listResponseScope)

      When you set the listResponseScope parameter to METADATA_ONLY, the list response includes: campaign name, Amazon Resource Name (ARN), creation time, and last modification time.

      Parameters:
      listResponseScope - When you set the listResponseScope parameter to METADATA_ONLY, the list response includes: campaign name, Amazon Resource Name (ARN), creation time, and last modification time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • listResponseScope

      ListCampaignsRequest.Builder listResponseScope(ListResponseScope listResponseScope)

      When you set the listResponseScope parameter to METADATA_ONLY, the list response includes: campaign name, Amazon Resource Name (ARN), creation time, and last modification time.

      Parameters:
      listResponseScope - When you set the listResponseScope parameter to METADATA_ONLY, the list response includes: campaign name, Amazon Resource Name (ARN), creation time, and last modification time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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

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