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() The bucket name that contains the objects.
static ListObjectVersionsRequest.Builder	builder()
String	delimiter() A delimiter is a character that you specify 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)
String	expectedBucketOwner() The account id of the expected bucket owner.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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() Use this parameter to select only those keys that begin with the specified prefix.
List<SdkField<?>>	sdkFields()
static Class<? extends ListObjectVersionsRequest.Builder>	serializableBuilderClass()
ListObjectVersionsRequest.Builder	toBuilder()
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

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

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

copy

Method Detail

bucket

public final String bucket()

The bucket name that contains the objects.

Returns:

The bucket name that contains the objects.

delimiter

public final String delimiter()

A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

Returns:

A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

encodingType

public final 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 final 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 final 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 final 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. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains <isTruncated>true</isTruncated>. To return the additional keys, see key-marker and version-id-marker.

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. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains <isTruncated>true</isTruncated>. To return the additional keys, see key-marker and version-id-marker.

prefix

public final String prefix()

Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

Returns:

Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

versionIdMarker

public final String versionIdMarker()

Specifies the object version you want to start listing from.

Returns:

Specifies the object version you want to start listing from.

expectedBucketOwner

public final String expectedBucketOwner()

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Returns:

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

toBuilder

public ListObjectVersionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListObjectVersionsRequest.Builder,ListObjectVersionsRequest>

Specified by:

toBuilder in class S3Request

builder

public static ListObjectVersionsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo