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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ListPartsRequest.Builder,ListPartsRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListPartsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`bucket()`	The name of the bucket to which the parts are being uploaded.
`static ListPartsRequest.Builder`	`builder()`
`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`	`key()`	Object key for which the multipart upload was initiated.
`Integer`	`maxParts()`	Sets the maximum number of parts to return.
`Integer`	`partNumberMarker()`	Specifies the part after which listing should begin.
`RequestPayer`	`requestPayer()`	Returns the value of the RequestPayer property for this object.
`String`	`requestPayerAsString()`	Returns the value of the RequestPayer property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListPartsRequest.Builder>`	`serializableBuilderClass()`
`String`	`sseCustomerAlgorithm()`	The server-side encryption (SSE) algorithm used to encrypt the object.
`String`	`sseCustomerKey()`	The server-side encryption (SSE) customer managed key.
`String`	`sseCustomerKeyMD5()`	The MD5 server-side encryption (SSE) customer managed key.
`ListPartsRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`uploadId()`	Upload ID identifying the multipart upload whose parts are being listed.

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 name of the bucket to which the parts are being uploaded.
    
    Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
    
    Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
    
    Access points and Object Lambda access points are not supported by directory buckets.
    
    S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
    
    Returns:
    
    The name of the bucket to which the parts are being uploaded.
    
    Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
    
    Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
    
    Access points and Object Lambda access points are not supported by directory buckets.
    
    S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
  - key
```
public final String key()
```
    Object key for which the multipart upload was initiated.
    
    Returns:
    
    Object key for which the multipart upload was initiated.
  - maxParts
```
public final Integer maxParts()
```
    Sets the maximum number of parts to return.
    
    Returns:
    
    Sets the maximum number of parts to return.
  - partNumberMarker
```
public final Integer partNumberMarker()
```
    Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
    
    Returns:
    
    Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
  - uploadId
```
public final String uploadId()
```
    Upload ID identifying the multipart upload whose parts are being listed.
    
    Returns:
    
    Upload ID identifying the multipart upload whose parts are being listed.
  - requestPayer
```
public final RequestPayer requestPayer()
```
    Returns the value of the RequestPayer property for this object.
    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:
    
    The value of the RequestPayer property for this object.
    
    See Also:
    
    RequestPayer
  - requestPayerAsString
```
public final String requestPayerAsString()
```
    Returns the value of the RequestPayer property for this object.
    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:
    
    The value of the RequestPayer property for this object.
    
    See Also:
    
    RequestPayer
  - expectedBucketOwner
```
public final String expectedBucketOwner()
```
    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
    
    Returns:
    
    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
  - sseCustomerAlgorithm
```
public final String sseCustomerAlgorithm()
```
    The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
    
    This functionality is not supported for directory buckets.
  - sseCustomerKey
```
public final String sseCustomerKey()
```
    The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
    
    This functionality is not supported for directory buckets.
  - sseCustomerKeyMD5
```
public final String sseCustomerKeyMD5()
```
    The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
    
    This functionality is not supported for directory buckets.
  - toBuilder
```
public ListPartsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListPartsRequest.Builder,ListPartsRequest>
    
    Specified by:
    
    toBuilder in class S3Request
  - builder
```
public static ListPartsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListPartsRequest.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

Class ListPartsRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

bucket

key

maxParts

partNumberMarker

uploadId

requestPayer

requestPayerAsString

expectedBucketOwner

sseCustomerAlgorithm

sseCustomerKey

sseCustomerKeyMD5

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields