@Generated(value="software.amazon.awssdk:codegen") public final class ListObjectVersionsRequest extends S3Request implements ToCopyableBuilder<ListObjectVersionsRequest.Builder,ListObjectVersionsRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
ListObjectVersionsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
bucket()
The bucket name that contains the objects.
|
static ListObjectVersionsRequest.Builder |
builder() |
String |
delimiter()
A delimiter is a character that you specify 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 |
keyMarker()
Specifies the key to start with when listing objects in a bucket.
|
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()
Use this parameter to select only those keys that begin with the specified prefix.
|
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 ListObjectVersionsRequest.Builder> |
serializableBuilderClass() |
ListObjectVersionsRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
versionIdMarker()
Specifies the object version you want to start listing from.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String bucket()
The bucket name that contains the objects.
public final String delimiter()
A delimiter is a character that you specify to group keys. All keys that contain the same string between the
prefix
and the first occurrence of the delimiter are grouped under a single result element in
CommonPrefixes
. These groups are counted as one result against the max-keys
limitation.
These keys are not returned elsewhere in the response.
prefix
and the first occurrence of the delimiter are grouped under a single result
element in CommonPrefixes
. These groups are counted as one result against the
max-keys
limitation. These keys are not returned elsewhere in the response.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 keyMarker()
Specifies the key to start with when listing objects in a 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. If additional keys satisfy the search
criteria, but were not returned because max-keys
was exceeded, the response contains
<isTruncated>true</isTruncated>
. To return the additional keys, see
key-marker
and version-id-marker
.
max-keys
was exceeded, the response contains
<isTruncated>true</isTruncated>
. To return the additional keys, see
key-marker
and version-id-marker
.public final String prefix()
Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to
separate a bucket into different groupings of keys. (You can think of using prefix
to make groups in
the same way that you'd use a folder in a file system.) You can use prefix
with
delimiter
to roll up numerous objects into a single result under CommonPrefixes
.
prefix
to
make groups in the same way that you'd use a folder in a file system.) You can use prefix
with delimiter
to roll up numerous objects into a single result under
CommonPrefixes
.public final String versionIdMarker()
Specifies the object version you want to start listing from.
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 RequestPayer requestPayer()
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()
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 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 ListObjectVersionsRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<ListObjectVersionsRequest.Builder,ListObjectVersionsRequest>
toBuilder
in class S3Request
public static ListObjectVersionsRequest.Builder builder()
public static Class<? extends ListObjectVersionsRequest.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.