Class ListObjectVersionsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListObjectVersionsRequest.Builder,
ListObjectVersionsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
bucket()
The bucket name that contains the objects.builder()
final String
A delimiter is a character that you specify to group keys.final EncodingType
Returns the value of the EncodingType property for this object.final String
Returns the value of the EncodingType property for this object.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The account ID of the expected bucket owner.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the OptionalObjectAttributes property.final String
Specifies the key to start with when listing objects in a bucket.final Integer
maxKeys()
Sets the maximum number of keys returned in the response.final List
<OptionalObjectAttributes> Specifies the optional fields that you want returned in the response.Specifies the optional fields that you want returned in the response.final String
prefix()
Use this parameter to select only those keys that begin with the specified prefix.final RequestPayer
Returns the value of the RequestPayer property for this object.final String
Returns the value of the RequestPayer property for this object.static Class
<? extends ListObjectVersionsRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
Specifies the object version you want to start listing from.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
bucket
The bucket name that contains the objects.
- Returns:
- The bucket name that contains the objects.
-
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 inCommonPrefixes
. These groups are counted as one result against themax-keys
limitation. These keys are not returned elsewhere in the response.- Returns:
- 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 inCommonPrefixes
. These groups are counted as one result against themax-keys
limitation. These keys are not returned elsewhere in the response.
-
encodingType
Returns the value of the EncodingType property for this object.If the service returns an enum value that is not available in the current SDK version,
encodingType
will returnEncodingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencodingTypeAsString()
.- Returns:
- The value of the EncodingType property for this object.
- See Also:
-
encodingTypeAsString
Returns the value of the EncodingType property for this object.If the service returns an enum value that is not available in the current SDK version,
encodingType
will returnEncodingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencodingTypeAsString()
.- Returns:
- The value of the EncodingType property for this object.
- See Also:
-
keyMarker
Specifies the key to start with when listing objects in a bucket.
- Returns:
- Specifies the key to start with when listing objects in a bucket.
-
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, seekey-marker
andversion-id-marker
.- Returns:
- 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, seekey-marker
andversion-id-marker
.
-
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 useprefix
withdelimiter
to roll up numerous objects into a single result underCommonPrefixes
.- Returns:
- 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 useprefix
withdelimiter
to roll up numerous objects into a single result underCommonPrefixes
.
-
versionIdMarker
Specifies the object version you want to start listing from.
- Returns:
- Specifies the object version you want to start listing from.
-
expectedBucketOwner
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code
403 Forbidden
(access denied).- Returns:
- The account ID of the expected bucket owner. If the account ID that you provide does not match the actual
owner of the bucket, the request fails with the HTTP status code
403 Forbidden
(access denied).
-
requestPayer
Returns the value of the RequestPayer property for this object.If the service returns an enum value that is not available in the current SDK version,
requestPayer
will returnRequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestPayerAsString()
.- Returns:
- The value of the RequestPayer property for this object.
- See Also:
-
requestPayerAsString
Returns the value of the RequestPayer property for this object.If the service returns an enum value that is not available in the current SDK version,
requestPayer
will returnRequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestPayerAsString()
.- Returns:
- The value of the RequestPayer property for this object.
- See Also:
-
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.- Returns:
- Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
-
hasOptionalObjectAttributes
public final boolean hasOptionalObjectAttributes()For responses, this returns true if the service returned a value for the OptionalObjectAttributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListObjectVersionsRequest.Builder,
ListObjectVersionsRequest> - Specified by:
toBuilder
in classS3Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-