Interface ListLocationsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListLocationsRequest.Builder,ListLocationsRequest>, DataSyncRequest.Builder, SdkBuilder<ListLocationsRequest.Builder,ListLocationsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListLocationsRequest
public static interface ListLocationsRequest.Builder extends DataSyncRequest.Builder, SdkPojo, CopyableBuilder<ListLocationsRequest.Builder,ListLocationsRequest>

  • Method Details

    • maxResults

      ListLocationsRequest.Builder maxResults(Integer maxResults)

      The maximum number of locations to return.

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

    • nextToken

      ListLocationsRequest.Builder nextToken(String nextToken)

      An opaque string that indicates the position at which to begin the next list of locations.

      Parameters:
      nextToken - An opaque string that indicates the position at which to begin the next list of locations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      ListLocationsRequest.Builder filters(Collection<LocationFilter> filters)

      You can use API filters to narrow down the list of resources returned by ListLocations. For example, to retrieve all tasks on a specific source location, you can use ListLocations with filter name LocationType S3 and Operator Equals.

      Parameters:
      filters - You can use API filters to narrow down the list of resources returned by ListLocations. For example, to retrieve all tasks on a specific source location, you can use ListLocations with filter name LocationType S3 and Operator Equals.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      ListLocationsRequest.Builder filters(LocationFilter... filters)

      You can use API filters to narrow down the list of resources returned by ListLocations. For example, to retrieve all tasks on a specific source location, you can use ListLocations with filter name LocationType S3 and Operator Equals.

      Parameters:
      filters - You can use API filters to narrow down the list of resources returned by ListLocations. For example, to retrieve all tasks on a specific source location, you can use ListLocations with filter name LocationType S3 and Operator Equals.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      ListLocationsRequest.Builder filters(Consumer<LocationFilter.Builder>... filters)

      You can use API filters to narrow down the list of resources returned by ListLocations. For example, to retrieve all tasks on a specific source location, you can use ListLocations with filter name LocationType S3 and Operator Equals.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<LocationFilter>).

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

    • overrideConfiguration

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

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