Interface ListContactsRequest.Builder

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

  • Method Details

    • contactListName

      ListContactsRequest.Builder contactListName(String contactListName)

      The name of the contact list.

      Parameters:
      contactListName - The name of the contact list.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filter

      ListContactsRequest.Builder filter(ListContactsFilter filter)

      A filter that can be applied to a list of contacts.

      Parameters:
      filter - A filter that can be applied to a list of contacts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filter

      default ListContactsRequest.Builder filter(Consumer<ListContactsFilter.Builder> filter)

      A filter that can be applied to a list of contacts.

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

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

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

    • pageSize

      ListContactsRequest.Builder pageSize(Integer pageSize)

      The number of contacts that may be returned at once, which is dependent on if there are more or less contacts than the value of the PageSize. Use this parameter to paginate results. If additional contacts exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional contacts.

      Parameters:
      pageSize - The number of contacts that may be returned at once, which is dependent on if there are more or less contacts than the value of the PageSize. Use this parameter to paginate results. If additional contacts exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional contacts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListContactsRequest.Builder nextToken(String nextToken)

      A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

      Parameters:
      nextToken - A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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