software.amazon.awssdk.services.s3.model

Class ListObjectVersionsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListObjectVersionsRequest.Builder,ListObjectVersionsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListObjectVersionsRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	bucket()
static ListObjectVersionsRequest.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) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	keyMarker() 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.
List<SdkField<?>>	sdkFields()
static Class<? extends ListObjectVersionsRequest.Builder>	serializableBuilderClass()
ListObjectVersionsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
String	versionIdMarker() Specifies the object version you want to start listing from.

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

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

keyMarker

public String keyMarker()

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.

versionIdMarker

public String versionIdMarker()

Specifies the object version you want to start listing from.

Returns:

Specifies the object version you want to start listing from.

toBuilder

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

Specified by:

toBuilder in class S3Request

Returns:

a builder for type T

builder

public static ListObjectVersionsRequest.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.