@Generated(value="software.amazon.awssdk:codegen") public final class ListObjectsV2Request extends S3Request implements ToCopyableBuilder<ListObjectsV2Request.Builder,ListObjectsV2Request>
Modifier and Type | Class and Description |
---|---|
static interface |
ListObjectsV2Request.Builder |
Modifier and Type | Method and Description |
---|---|
String |
bucket()
Bucket name to list.
|
static ListObjectsV2Request.Builder |
builder() |
String |
continuationToken()
ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token.
|
String |
delimiter()
A delimiter is a character you use to group keys.
|
EncodingType |
encodingType()
Encoding type used by Amazon S3 to encode object keys in the response.
|
String |
encodingTypeAsString()
Encoding type used by Amazon S3 to encode object keys in the response.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
expectedBucketOwner()
The account ID of the expected bucket owner.
|
Boolean |
fetchOwner()
The owner field is not present in listV2 by default, if you want to return owner field with each key in the
result then set the fetch owner field to true.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
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.
|
RequestPayer |
requestPayer()
Confirms that the requester knows that she or he will be charged for the list objects request in V2 style.
|
String |
requestPayerAsString()
Confirms that the requester knows that she or he will be charged for the list objects request in V2 style.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ListObjectsV2Request.Builder> |
serializableBuilderClass() |
String |
startAfter()
StartAfter is where you want Amazon S3 to start listing from.
|
ListObjectsV2Request.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String bucket()
Bucket name to list.
When using this action with an access point, 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.
When using 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 using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket
ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in
the Amazon S3 User Guide.
When using this action with an access point, 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.
When using 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 using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the
Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on
Outposts in the Amazon S3 User Guide.
public final String delimiter()
A delimiter is a character you use to group keys.
public final EncodingType encodingType()
Encoding type used by Amazon S3 to encode object keys in the response.
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()
.
EncodingType
public final String encodingTypeAsString()
Encoding type used by Amazon S3 to encode object keys in the response.
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()
.
EncodingType
public final Integer 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.
public final String prefix()
Limits the response to keys that begin with the specified prefix.
public final String continuationToken()
ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.
public final Boolean fetchOwner()
The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true.
public final String 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.
public final RequestPayer 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.
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()
.
RequestPayer
public final String 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.
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()
.
RequestPayer
public final String expectedBucketOwner()
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails
with the HTTP status code 403 Forbidden
(access denied).
403 Forbidden
(access denied).public ListObjectsV2Request.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<ListObjectsV2Request.Builder,ListObjectsV2Request>
toBuilder
in class S3Request
public static ListObjectsV2Request.Builder builder()
public static Class<? extends ListObjectsV2Request.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2022. All rights reserved.