Interface DescribeOptOutListsRequest.Builder

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

  • Method Details

    • optOutListNames

      DescribeOptOutListsRequest.Builder optOutListNames(Collection<String> optOutListNames)

      The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.

      If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

      Parameters:
      optOutListNames - The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.

      If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

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

    • optOutListNames

      DescribeOptOutListsRequest.Builder optOutListNames(String... optOutListNames)

      The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.

      If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

      Parameters:
      optOutListNames - The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.

      If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

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

    • nextToken

      DescribeOptOutListsRequest.Builder nextToken(String nextToken)

      The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

      Parameters:
      nextToken - The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      DescribeOptOutListsRequest.Builder maxResults(Integer maxResults)

      The maximum number of results to return per each request.

      Parameters:
      maxResults - The maximum number of results to return per each request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • owner

      DescribeOptOutListsRequest.Builder owner(String owner)

      Use SELF to filter the list of Opt-Out List to ones your account owns or use SHARED to filter on Opt-Out List shared with your account. The Owner and OptOutListNames parameters can't be used at the same time.

      Parameters:
      owner - Use SELF to filter the list of Opt-Out List to ones your account owns or use SHARED to filter on Opt-Out List shared with your account. The Owner and OptOutListNames parameters can't be used at the same time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • owner

      DescribeOptOutListsRequest.Builder owner(Owner owner)

      Use SELF to filter the list of Opt-Out List to ones your account owns or use SHARED to filter on Opt-Out List shared with your account. The Owner and OptOutListNames parameters can't be used at the same time.

      Parameters:
      owner - Use SELF to filter the list of Opt-Out List to ones your account owns or use SHARED to filter on Opt-Out List shared with your account. The Owner and OptOutListNames parameters can't be used at the same time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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