ListObjectVersionsRequest (IBM COS Java SDK

java.lang.Object
- com.ibm.cos.v2.core.SdkRequest
- - com.ibm.cos.v2.awscore.AwsRequest
  - - com.ibm.cos.v2.services.s3.model.S3Request
    - - com.ibm.cos.v2.services.s3.model.ListObjectVersionsRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ListObjectVersionsRequest.Builder,ListObjectVersionsRequest>

@Generated(value="com.ibm.cos.v2:codegen")
public final class ListObjectVersionsRequest
extends S3Request
implements ToCopyableBuilder<ListObjectVersionsRequest.Builder,ListObjectVersionsRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ListObjectVersionsRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ListObjectVersionsRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()`
`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.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`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.

Methods inherited from class com.ibm.cos.v2.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - bucket
```
public final String bucket()
```
    The bucket name that contains the objects.
    
    Returns:
    
    The bucket name that contains the objects.
  - delimiter
```
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.
    
    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 in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.
  - encodingType
```
public final EncodingType 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 return EncodingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encodingTypeAsString().
    
    Returns:
    
    The value of the EncodingType property for this object.
    
    See Also:
    
    EncodingType
  - encodingTypeAsString
```
public final String 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 return EncodingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encodingTypeAsString().
    
    Returns:
    
    The value of the EncodingType property for this object.
    
    See Also:
    
    EncodingType
  - keyMarker
```
public final String 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
```
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.
    
    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, see key-marker and version-id-marker.
  - prefix
```
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.
    
    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 use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.
  - versionIdMarker
```
public final String versionIdMarker()
```
    Specifies the object version you want to start listing from.
    
    Returns:
    
    Specifies the object version you want to start listing from.
  - expectedBucketOwner
```
public final String 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
```
public final RequestPayer 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 return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().
    
    Returns:
    
    The value of the RequestPayer property for this object.
    
    See Also:
    
    RequestPayer
  - requestPayerAsString
```
public final String 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 return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().
    
    Returns:
    
    The value of the RequestPayer property for this object.
    
    See Also:
    
    RequestPayer
  - optionalObjectAttributes
```
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.
    
    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 the 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.
  - optionalObjectAttributesAsStrings
```
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.
    
    Returns:
    
    Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
  - toBuilder
```
public ListObjectVersionsRequest.Builder 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 interface ToCopyableBuilder<ListObjectVersionsRequest.Builder,ListObjectVersionsRequest>
    
    Specified by:
    
    toBuilder in class S3Request
    
    Returns:
    
    a builder for type T
  - builder
```
public static ListObjectVersionsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListObjectVersionsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    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 an SdkPojo 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.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - toString
```
public final String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. 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.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    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
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo
    
    Returns:
    
    The mapping between the field name and its corresponding field.

Class ListObjectVersionsRequest

Nested Class Summary

Method Summary

Methods inherited from class com.ibm.cos.v2.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder

Method Detail

bucket

delimiter

encodingType

encodingTypeAsString

keyMarker

maxKeys

prefix

versionIdMarker

expectedBucketOwner

requestPayer

requestPayerAsString

optionalObjectAttributes

hasOptionalObjectAttributes

optionalObjectAttributesAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField