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

Class ListObjectsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.s3.model.ListObjectsRequest

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListObjectsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	bucket()
static ListObjectsRequest.Builder	builder()
String	delimiter()	A delimiter is a character you use to group keys.
String	encodingType()
boolean	equals(Object obj)
int	hashCode()
String	marker()	Specifies the key to start with when listing objects in a bucket.
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.
static Class<? extends ListObjectsRequest.Builder>	serializableBuilderClass()
ListObjectsRequest.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()

Returns:

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()

Returns:

See Also:

EncodingType

marker

public String marker()

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

Returns:

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

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.

requestPayer

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

Returns:

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.

See Also:

RequestPayer

toBuilder

public ListObjectsRequest.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<ListObjectsRequest.Builder,ListObjectsRequest>

Returns:

a builder for type T

builder

public static ListObjectsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListObjectsRequest.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