software.amazon.awssdk.services.s3.model

Interface ListObjectsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListObjectsRequest.Builder,ListObjectsRequest>, S3Request.Builder, SdkBuilder<ListObjectsRequest.Builder,ListObjectsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListObjectsRequest

public static interface ListObjectsRequest.Builder
extends S3Request.Builder, SdkPojo, CopyableBuilder<ListObjectsRequest.Builder,ListObjectsRequest>

Method Summary

Modifier and Type	Method and Description
ListObjectsRequest.Builder	bucket(String bucket) Sets the value of the Bucket property for this object.
ListObjectsRequest.Builder	delimiter(String delimiter) A delimiter is a character you use to group keys.
ListObjectsRequest.Builder	encodingType(EncodingType encodingType) Sets the value of the EncodingType property for this object.
ListObjectsRequest.Builder	encodingType(String encodingType) Sets the value of the EncodingType property for this object.
ListObjectsRequest.Builder	marker(String marker) Specifies the key to start with when listing objects in a bucket.
ListObjectsRequest.Builder	maxKeys(Integer maxKeys) Sets the maximum number of keys returned in the response.
ListObjectsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
ListObjectsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
ListObjectsRequest.Builder	prefix(String prefix) Limits the response to keys that begin with the specified prefix.
ListObjectsRequest.Builder	requestPayer(RequestPayer requestPayer) Confirms that the requester knows that she or he will be charged for the list objects request.
ListObjectsRequest.Builder	requestPayer(String requestPayer) Confirms that the requester knows that she or he will be charged for the list objects request.

Methods inherited from interface software.amazon.awssdk.services.s3.model.S3Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

bucket

ListObjectsRequest.Builder bucket(String bucket)

Sets the value of the Bucket property for this object.

Parameters:

bucket - The new value for the Bucket property for this object.

Returns:

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

delimiter

ListObjectsRequest.Builder delimiter(String delimiter)

A delimiter is a character you use to group keys.

Parameters:

delimiter - A delimiter is a character you use to group keys.

Returns:

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

encodingType

ListObjectsRequest.Builder encodingType(String encodingType)

Sets the value of the EncodingType property for this object.

Parameters:

encodingType - The new value for the EncodingType property for this object.

Returns:

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

See Also:

EncodingType, EncodingType

encodingType

ListObjectsRequest.Builder encodingType(EncodingType encodingType)

Sets the value of the EncodingType property for this object.

Parameters:

encodingType - The new value for the EncodingType property for this object.

Returns:

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

See Also:

EncodingType, EncodingType

marker

ListObjectsRequest.Builder marker(String marker)

Specifies the key to start with when listing objects in a bucket.

Parameters:

marker - Specifies the key to start with when listing objects in a bucket.

Returns:

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

maxKeys

ListObjectsRequest.Builder maxKeys(Integer maxKeys)

Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.

Parameters:

maxKeys - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.

Returns:

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

prefix

ListObjectsRequest.Builder prefix(String prefix)

Limits the response to keys that begin with the specified prefix.

Parameters:

prefix - Limits the response to keys that begin with the specified prefix.

Returns:

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

requestPayer

ListObjectsRequest.Builder requestPayer(String requestPayer)

Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

Parameters:

requestPayer - Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

Returns:

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

See Also:

RequestPayer, RequestPayer

requestPayer

ListObjectsRequest.Builder requestPayer(RequestPayer requestPayer)

Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

Parameters:

requestPayer - Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

Returns:

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

See Also:

RequestPayer, RequestPayer

overrideConfiguration

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

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