@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 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() |
String |
marker()
Specifies the key to start with when listing objects in a bucket.
|
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.
|
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 String bucket()
The name of the bucket containing the objects.
When using this API 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 operation with an access point through the AWS 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 Simple Storage Service Developer Guide.
When using this API 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 operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
When using this API 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 operation with an access point through the AWS 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 Simple Storage Service Developer Guide.
When using this API 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 operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
public String delimiter()
A delimiter is a character you use to group keys.
public 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 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 String marker()
Specifies the key to start with when listing objects in a bucket.
public Integer maxKeys()
Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.
public String prefix()
Limits the response to keys that begin with the specified prefix.
public 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 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 String expectedBucketOwner()
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail
with an HTTP 403 (Access Denied)
error.
403 (Access Denied)
error.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 int hashCode()
hashCode
in class AwsRequest
public boolean equals(Object obj)
equals
in class AwsRequest
public boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public String toString()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2020. All rights reserved.