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

Class ListObjectsV2Request

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.s3.model.ListObjectsV2Request

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<ListObjectsV2Request.Builder,ListObjectsV2Request>

@Generated("software.amazon.awssdk:codegen")
public class ListObjectsV2Request
extends AmazonWebServiceRequest
implements ToCopyableBuilder<ListObjectsV2Request.Builder,ListObjectsV2Request>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListObjectsV2Request.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	bucket()	Name of the bucket to list.
static ListObjectsV2Request.Builder	builder()
String	continuationToken()	ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token.
String	delimiter()	A delimiter is a character you use to group keys.
String	encodingType()	Encoding type used by Amazon S3 to encode object keys in the response.
boolean	equals(Object obj)
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
int	hashCode()
Integer	maxKeys()	Sets the maximum number of keys returned in the response.
String	prefix()	Limits the response to keys that begin with the specified prefix.
String	requestPayer()	Confirms that the requester knows that she or he will be charged for the list objects request in V2 style.
static Class<? extends ListObjectsV2Request.Builder>	serializableBuilderClass()
String	startAfter()	StartAfter is where you want Amazon S3 to start listing from.
ListObjectsV2Request.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

bucket

public String bucket()

Name of the bucket to list.

Returns:

Name of the bucket to list.

delimiter

public String delimiter()

A delimiter is a character you use to group keys.

Returns:

A delimiter is a character you use to group keys.

encodingType

public String encodingType()

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

Returns:

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

See Also:

EncodingType

maxKeys

public Integer maxKeys()

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

Returns:

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

prefix

public String prefix()

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

Returns:

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

continuationToken

public 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

Returns:

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

fetchOwner

public 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

Returns:

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

startAfter

public 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

Returns:

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

requestPayer

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

Returns:

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.

See Also:

RequestPayer

toBuilder

public ListObjectsV2Request.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListObjectsV2Request.Builder,ListObjectsV2Request>

Returns:

a builder for type T

builder

public static ListObjectsV2Request.Builder builder()

serializableBuilderClass

public static Class<? extends ListObjectsV2Request.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object