Package software.amazon.awssdk.services.s3.model

Interface ListObjectsV2Request.Builder

All Superinterfaces:

CopyableBuilder<ListObjectsV2Request.Builder,ListObjectsV2Request>, SdkBuilder<ListObjectsV2Request.Builder,ListObjectsV2Request>

Enclosing class:

ListObjectsV2Request

public static interface ListObjectsV2Request.Builder
extends CopyableBuilder<ListObjectsV2Request.Builder,ListObjectsV2Request>

Method Summary

Modifier and Type	Method	Description
ListObjectsV2Request.Builder	bucket(String bucket)	Name of the bucket to list.
ListObjectsV2Request.Builder	continuationToken(String continuationToken)	ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token.
ListObjectsV2Request.Builder	delimiter(String delimiter)	A delimiter is a character you use to group keys.
ListObjectsV2Request.Builder	encodingType(String encodingType)	Encoding type used by Amazon S3 to encode object keys in the response.
ListObjectsV2Request.Builder	encodingType(EncodingType encodingType)	Encoding type used by Amazon S3 to encode object keys in the response.
ListObjectsV2Request.Builder	fetchOwner(Boolean fetchOwner)	The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true
ListObjectsV2Request.Builder	maxKeys(Integer maxKeys)	Sets the maximum number of keys returned in the response.
ListObjectsV2Request.Builder	prefix(String prefix)	Limits the response to keys that begin with the specified prefix.
ListObjectsV2Request.Builder	requestPayer(String requestPayer)	Confirms that the requester knows that she or he will be charged for the list objects request in V2 style.
ListObjectsV2Request.Builder	requestPayer(RequestPayer requestPayer)	Confirms that the requester knows that she or he will be charged for the list objects request in V2 style.
ListObjectsV2Request.Builder	startAfter(String startAfter)	StartAfter is where you want Amazon S3 to start listing from.

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

copy

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

apply, build

Method Detail

bucket

ListObjectsV2Request.Builder bucket(String bucket)

Name of the bucket to list.

Parameters:

bucket - Name of the bucket to list.

Returns:

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

delimiter

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

ListObjectsV2Request.Builder encodingType(String encodingType)

Encoding type used by Amazon S3 to encode object keys in the response.

Parameters:

encodingType - Encoding type used by Amazon S3 to encode object keys in the response.

Returns:

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

See Also:

EncodingType

encodingType

ListObjectsV2Request.Builder encodingType(EncodingType encodingType)

Encoding type used by Amazon S3 to encode object keys in the response.

Parameters:

encodingType - Encoding type used by Amazon S3 to encode object keys in the response.

Returns:

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

See Also:

EncodingType

maxKeys

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

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

continuationToken

ListObjectsV2Request.Builder continuationToken(String continuationToken)

ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key

Parameters:

continuationToken - ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key

Returns:

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

fetchOwner

ListObjectsV2Request.Builder fetchOwner(Boolean fetchOwner)

The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true

Parameters:

fetchOwner - The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true

Returns:

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

startAfter

ListObjectsV2Request.Builder startAfter(String startAfter)

StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket

Parameters:

startAfter - StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket

Returns:

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

requestPayer

ListObjectsV2Request.Builder requestPayer(String requestPayer)

Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. 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 in V2 style. 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

ListObjectsV2Request.Builder requestPayer(RequestPayer requestPayer)

Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. 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 in V2 style. 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