software.amazon.awssdk.services.s3.model

Class ListObjectsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.s3.model.S3Request

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListObjectsRequest.Builder,ListObjectsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListObjectsRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	bucket() The name of the bucket containing the objects.
static ListObjectsRequest.Builder	builder()
String	delimiter() A delimiter is a character you use to group keys.
EncodingType	encodingType() Returns the value of the EncodingType property for this object.
String	encodingTypeAsString() Returns the value of the EncodingType property for this object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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.
RequestPayer	requestPayer() Confirms that the requester knows that she or he will be charged for the list objects request.
String	requestPayerAsString() Confirms that the requester knows that she or he will be charged for the list objects request.
List<SdkField<?>>	sdkFields()
static Class<? extends ListObjectsRequest.Builder>	serializableBuilderClass()
ListObjectsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

bucket

public String bucket()

The name of the bucket containing the objects.

Returns:

The name of the bucket containing the objects.

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

Returns the value of the EncodingType property for this object.

If the service returns an enum value that is not available in the current SDK version, encodingType will return EncodingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encodingTypeAsString().

Returns:

The value of the EncodingType property for this object.

See Also:

EncodingType

encodingTypeAsString

public String encodingTypeAsString()

Returns the value of the EncodingType property for this object.

If the service returns an enum value that is not available in the current SDK version, encodingType will return EncodingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encodingTypeAsString().

Returns:

The value of the EncodingType property for this object.

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. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Returns:

Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. 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 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.

If the service returns an enum value that is not available in the current SDK version, requestPayer will return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().

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

requestPayerAsString

public String requestPayerAsString()

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.

If the service returns an enum value that is not available in the current SDK version, requestPayer will return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().

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

Specified by:

toBuilder in interface ToCopyableBuilder<ListObjectsRequest.Builder,ListObjectsRequest>

Specified by:

toBuilder in class S3Request

builder

public static ListObjectsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo