@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)
Indicates whether some other object is "equal to" this one by SDK fields.
|
String |
expectedBucketOwner()
The account ID of the expected bucket owner.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
int |
hashCode() |
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.
|
String |
prefix()
Use this parameter to select only those keys that begin with the specified prefix.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ListObjectVersionsRequest.Builder> |
serializableBuilderClass() |
ListObjectVersionsRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
String |
versionIdMarker()
Specifies the object version you want to start listing from.
|
overrideConfigurationcopypublic 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().
EncodingTypepublic 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().
EncodingTypepublic 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.
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 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 will fail
with an HTTP 403 (Access Denied) error.
403 (Access Denied) error.public ListObjectVersionsRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<ListObjectVersionsRequest.Builder,ListObjectVersionsRequest>toBuilder in class S3Requestpublic static ListObjectVersionsRequest.Builder builder()
public static Class<? extends ListObjectVersionsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.