@Generated(value="software.amazon.awssdk:codegen") public final class ListObjectsRequest extends S3Request implements ToCopyableBuilder<ListObjectsRequest.Builder,ListObjectsRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
ListObjectsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
bucket()
The name of the bucket containing the objects.
|
static ListObjectsRequest.Builder |
builder() |
String |
delimiter()
A delimiter is a character that 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) |
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() |
boolean |
hasOptionalObjectAttributes()
For responses, this returns true if the service returned a value for the OptionalObjectAttributes property.
|
String |
marker()
Marker is where you want Amazon S3 to start listing from.
|
Integer |
maxKeys()
Sets the maximum number of keys returned in the response.
|
List<OptionalObjectAttributes> |
optionalObjectAttributes()
Specifies the optional fields that you want returned in the response.
|
List<String> |
optionalObjectAttributesAsStrings()
Specifies the optional fields that you want 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.
|
String |
requestPayerAsString()
Confirms that the requester knows that she or he will be charged for the list objects request.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ListObjectsRequest.Builder> |
serializableBuilderClass() |
ListObjectsRequest.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()
The name of the bucket containing the objects.
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 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.
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 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.
public final String delimiter()
A delimiter is a character that you use to group keys.
public final EncodingType encodingType()
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()
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 marker()
Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.
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 RequestPayer requestPayer()
Confirms that the requester knows that she or he will be charged for the list objects request. 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. 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 final List<OptionalObjectAttributes> optionalObjectAttributes()
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
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.
public final boolean hasOptionalObjectAttributes()
isEmpty()
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.public final List<String> optionalObjectAttributesAsStrings()
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
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.
public ListObjectsRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<ListObjectsRequest.Builder,ListObjectsRequest>
toBuilder
in class S3Request
public static ListObjectsRequest.Builder builder()
public static Class<? extends ListObjectsRequest.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 © 2023. All rights reserved.