software.amazon.awssdk.services.s3.model

Class ListMultipartUploadsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListMultipartUploadsRequest.Builder,ListMultipartUploadsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListMultipartUploadsRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	bucket() Returns the value of the Bucket property for this object.
static ListMultipartUploadsRequest.Builder	builder()
String	delimiter() 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)
<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() Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.
Integer	maxUploads() Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body.
String	prefix() Lists in-progress uploads only for those keys that begin with the specified prefix.
List<SdkField<?>>	sdkFields()
static Class<? extends ListMultipartUploadsRequest.Builder>	serializableBuilderClass()
ListMultipartUploadsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	uploadIdMarker() Together with key-marker, specifies the multipart upload after which listing should begin.

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 the value of the Bucket property for this object.

Returns:

The value of the Bucket property for this object.

delimiter

public String delimiter()

Character you use to group keys.

Returns:

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

Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

Returns:

Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

maxUploads

public Integer maxUploads()

Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.

Returns:

Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.

prefix

public String prefix()

Lists in-progress uploads only for those keys that begin with the specified prefix.

Returns:

Lists in-progress uploads only for those keys that begin with the specified prefix.

uploadIdMarker

public String uploadIdMarker()

Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored.

Returns:

Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored.

toBuilder

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

Specified by:

toBuilder in class S3Request

Returns:

a builder for type T

builder

public static ListMultipartUploadsRequest.Builder builder()

serializableBuilderClass

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

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.