Interface ListSubscriptionsRequest.Builder

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

  • Method Details

    • clientId

      ListSubscriptionsRequest.Builder clientId(String clientId)

      The unique identifier of the MQTT client to list subscriptions for. The client ID can't start with a dollar sign ($).

      MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.

      Parameters:
      clientId - The unique identifier of the MQTT client to list subscriptions for. The client ID can't start with a dollar sign ($).

      MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.

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

    • nextToken

      ListSubscriptionsRequest.Builder nextToken(String nextToken)

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

      Parameters:
      nextToken - To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListSubscriptionsRequest.Builder maxResults(Integer maxResults)

      The maximum number of subscriptions to return in a single request. By default, this is set to 20.

      Parameters:
      maxResults - The maximum number of subscriptions to return in a single request. By default, this is set to 20.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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