Class ListObjectsV2Request
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListObjectsV2Request.Builder,
ListObjectsV2Request>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
bucket()
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the formatBucket_name.s3express-az_id.region.amazonaws.com
.static ListObjectsV2Request.Builder
builder()
final String
ContinuationToken
indicates to Amazon S3 that the list is being continued on this bucket with a token.final String
A delimiter is a character that you use to group keys.final EncodingType
Encoding type used by Amazon S3 to encode object keys in the response.final String
Encoding type used by Amazon S3 to encode object keys in the response.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The account ID of the expected bucket owner.final Boolean
The owner field is not present inListObjectsV2
by default.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the OptionalObjectAttributes property.final Integer
maxKeys()
Sets the maximum number of keys returned in the response.final List
<OptionalObjectAttributes> Specifies the optional fields that you want returned in the response.Specifies the optional fields that you want returned in the response.final String
prefix()
Limits the response to keys that begin with the specified prefix.final RequestPayer
Confirms that the requester knows that she or he will be charged for the list objects request in V2 style.final String
Confirms that the requester knows that she or he will be charged for the list objects request in V2 style.static Class
<? extends ListObjectsV2Request.Builder> final String
StartAfter is where you want Amazon S3 to start listing from.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
bucket
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 formatbucket_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:
- 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 formatbucket_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.
-
delimiter
A delimiter is a character that you use to group keys.
-
Directory buckets - For directory buckets,
/
is the only supported delimiter. -
Directory buckets - When you query
ListObjectsV2
with a delimiter during in-progress multipart uploads, theCommonPrefixes
response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.
- Returns:
- A delimiter is a character that you use to group keys.
-
Directory buckets - For directory buckets,
/
is the only supported delimiter. -
Directory buckets - When you query
ListObjectsV2
with a delimiter during in-progress multipart uploads, theCommonPrefixes
response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.
-
-
-
encodingType
Encoding type used by Amazon S3 to encode object keys in the response. If using
url
, non-ASCII characters used in an object's key name will be URL encoded. For example, the object test_file(3).png will appear as test_file%283%29.png.If the service returns an enum value that is not available in the current SDK version,
encodingType
will returnEncodingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencodingTypeAsString()
.- Returns:
- Encoding type used by Amazon S3 to encode object keys in the response. If using
url
, non-ASCII characters used in an object's key name will be URL encoded. For example, the object test_file(3).png will appear as test_file%283%29.png. - See Also:
-
encodingTypeAsString
Encoding type used by Amazon S3 to encode object keys in the response. If using
url
, non-ASCII characters used in an object's key name will be URL encoded. For example, the object test_file(3).png will appear as test_file%283%29.png.If the service returns an enum value that is not available in the current SDK version,
encodingType
will returnEncodingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencodingTypeAsString()
.- Returns:
- Encoding type used by Amazon S3 to encode object keys in the response. If using
url
, non-ASCII characters used in an object's key name will be URL encoded. For example, the object test_file(3).png will appear as test_file%283%29.png. - See Also:
-
maxKeys
Sets the maximum number of keys returned in the response. By default, the action 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 action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.
-
prefix
Limits the response to keys that begin with the specified prefix.
Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/
) are supported.- Returns:
- Limits the response to keys that begin with the specified prefix.
Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/
) are supported.
-
continuationToken
ContinuationToken
indicates to Amazon S3 that the list is being continued on this bucket with a token.ContinuationToken
is obfuscated and is not a real key. You can use thisContinuationToken
for pagination of the list results.- Returns:
ContinuationToken
indicates to Amazon S3 that the list is being continued on this bucket with a token.ContinuationToken
is obfuscated and is not a real key. You can use thisContinuationToken
for pagination of the list results.
-
fetchOwner
The owner field is not present in
ListObjectsV2
by default. If you want to return the owner field with each key in the result, then set theFetchOwner
field totrue
.Directory buckets - For directory buckets, the bucket owner is returned as the object owner for all objects.
- Returns:
- The owner field is not present in
ListObjectsV2
by default. If you want to return the owner field with each key in the result, then set theFetchOwner
field totrue
.Directory buckets - For directory buckets, the bucket owner is returned as the object owner for all objects.
-
startAfter
StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.
This functionality is not supported for directory buckets.
- Returns:
- StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this
specified key. StartAfter can be any key in the bucket.
This functionality is not supported for directory buckets.
-
requestPayer
Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.
This functionality is not supported for directory buckets.
If the service returns an enum value that is not available in the current SDK version,
requestPayer
will returnRequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestPayerAsString()
.- Returns:
- Confirms that the requester knows that she or he will be charged for the list objects request in V2
style. Bucket owners need not specify this parameter in their requests.
This functionality is not supported for directory buckets.
- See Also:
-
requestPayerAsString
Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.
This functionality is not supported for directory buckets.
If the service returns an enum value that is not available in the current SDK version,
requestPayer
will returnRequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestPayerAsString()
.- Returns:
- Confirms that the requester knows that she or he will be charged for the list objects request in V2
style. Bucket owners need not specify this parameter in their requests.
This functionality is not supported for directory buckets.
- See Also:
-
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).
-
optionalObjectAttributes
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
This functionality is not supported for directory buckets.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasOptionalObjectAttributes()
method.- Returns:
- Specifies the optional fields that you want returned in the response. Fields that you do not specify are
not returned.
This functionality is not supported for directory buckets.
-
hasOptionalObjectAttributes
public final boolean hasOptionalObjectAttributes()For responses, this returns true if the service returned a value for the OptionalObjectAttributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
optionalObjectAttributesAsStrings
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
This functionality is not supported for directory buckets.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasOptionalObjectAttributes()
method.- Returns:
- Specifies the optional fields that you want returned in the response. Fields that you do not specify are
not returned.
This functionality is not supported for directory buckets.
-
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 interfaceToCopyableBuilder<ListObjectsV2Request.Builder,
ListObjectsV2Request> - Specified by:
toBuilder
in classS3Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-