ListObjectsV2Response (IBM COS Java SDK

java.lang.Object
- com.ibm.cos.v2.core.SdkResponse
- - com.ibm.cos.v2.awscore.AwsResponse
  - - com.ibm.cos.v2.services.s3.model.S3Response
    - - com.ibm.cos.v2.services.s3.model.ListObjectsV2Response

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ListObjectsV2Response.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ListObjectsV2Response.Builder`	`builder()`
`List<CommonPrefix>`	`commonPrefixes()` All of the keys (up to 1,000) that share the same prefix are grouped together.
`List<S3Object>`	`contents()` Metadata about each object returned.
`String`	`continuationToken()` If `ContinuationToken` was sent with the request, it is included in the response.
`String`	`delimiter()` Causes keys that contain the same string between the `prefix` and the first occurrence of the delimiter to be rolled up into a single result element in the `CommonPrefixes` collection.
`EncodingType`	`encodingType()` Encoding type used by Amazon S3 to encode object key names in the XML response.
`String`	`encodingTypeAsString()` Encoding type used by Amazon S3 to encode object key names in the XML response.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkResponse`.
`boolean`	`hasCommonPrefixes()` For responses, this returns true if the service returned a value for the CommonPrefixes property.
`boolean`	`hasContents()` For responses, this returns true if the service returned a value for the Contents property.
`int`	`hashCode()`
`Boolean`	`isTruncated()` Set to `false` if all of the results were returned.
`Integer`	`keyCount()` `KeyCount` is the number of keys returned with this request.
`Integer`	`maxKeys()` Sets the maximum number of keys returned in the response.
`String`	`name()` The bucket name.
`String`	`nextContinuationToken()` `NextContinuationToken` is sent when `isTruncated` is true, which means there are more keys in the bucket that can be listed.
`String`	`prefix()` Keys that begin with the indicated prefix.
`RequestCharged`	`requestCharged()` Returns the value of the RequestCharged property for this object.
`String`	`requestChargedAsString()` Returns the value of the RequestCharged property for this object.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListObjectsV2Response.Builder>`	`serializableBuilderClass()`
`String`	`startAfter()` If StartAfter was sent with the request, it is included in the response.
`ListObjectsV2Response.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.

Methods inherited from class com.ibm.cos.v2.services.s3.model.S3Response
responseMetadata

Methods inherited from class com.ibm.cos.v2.core.SdkResponse
sdkHttpResponse

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
  - isTruncated
```
public final Boolean isTruncated()
```
    Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.
    
    Returns:
    
    Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.
  - hasContents
```
public final boolean hasContents()
```
    For responses, this returns true if the service returned a value for the Contents 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.
  - contents
```
public final List<S3Object> contents()
```
    Metadata about each object 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 hasContents() method.
    
    Returns:
    
    Metadata about each object returned.
  - name
```
public final String name()
```
    The bucket name.
    
    Returns:
    
    The bucket name.
  - prefix
```
public final String prefix()
```
    Keys that begin with the indicated prefix.
    
    Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.
    
    Returns:
    
    Keys that begin with the indicated prefix.
    
    Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.
  - delimiter
```
public final String delimiter()
```
    Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.
    
    Directory buckets - For directory buckets, / is the only supported delimiter.
    
    Returns:
    
    Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.
    
    Directory buckets - For directory buckets, / is the only supported delimiter.
  - 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.
    
    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.
  - hasCommonPrefixes
```
public final boolean hasCommonPrefixes()
```
    For responses, this returns true if the service returned a value for the CommonPrefixes 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.
  - commonPrefixes
```
public final List<CommonPrefix> commonPrefixes()
```
    All of the keys (up to 1,000) that share the same prefix are grouped together. When counting the total numbers of returns by this API operation, this group of keys is considered as one item.
    
    A response can contain CommonPrefixes only if you specify a delimiter.
    
    CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter.
    
    CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.
    
    For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.
    Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.
    
    Directory buckets - When you query ListObjectsV2 with a delimiter during in-progress multipart uploads, the CommonPrefixes response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.
    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 hasCommonPrefixes() method.
    Returns:
    All of the keys (up to 1,000) that share the same prefix are grouped together. When counting the total numbers of returns by this API operation, this group of keys is considered as one item.
    
    A response can contain CommonPrefixes only if you specify a delimiter.
    
    CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter.
    
    CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.
    
    For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.
    
    Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.
    
    Directory buckets - When you query ListObjectsV2 with a delimiter during in-progress multipart uploads, the CommonPrefixes response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.
  - encodingType
```
public final EncodingType encodingType()
```
    Encoding type used by Amazon S3 to encode object key names in the XML response.
    
    If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:
    
    Delimiter, Prefix, Key, and StartAfter.
    
    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:
    
    Encoding type used by Amazon S3 to encode object key names in the XML response.
    
    If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:
    
    Delimiter, Prefix, Key, and StartAfter.
    
    See Also:
    
    EncodingType
  - encodingTypeAsString
```
public final String encodingTypeAsString()
```
    Encoding type used by Amazon S3 to encode object key names in the XML response.
    
    If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:
    
    Delimiter, Prefix, Key, and StartAfter.
    
    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:
    
    Encoding type used by Amazon S3 to encode object key names in the XML response.
    
    If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:
    
    Delimiter, Prefix, Key, and StartAfter.
    
    See Also:
    
    EncodingType
  - keyCount
```
public final Integer keyCount()
```
    KeyCount is the number of keys returned with this request. KeyCount will always be less than or equal to the MaxKeys field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.
    
    Returns:
    
    KeyCount is the number of keys returned with this request. KeyCount will always be less than or equal to the MaxKeys field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.
  - continuationToken
```
public final String continuationToken()
```
    If ContinuationToken was sent with the request, it is included in the response. You can use the returned ContinuationToken for pagination of the list response. You can use this ContinuationToken for pagination of the list results.
    
    Returns:
    
    If ContinuationToken was sent with the request, it is included in the response. You can use the returned ContinuationToken for pagination of the list response. You can use this ContinuationToken for pagination of the list results.
  - nextContinuationToken
```
public final String nextContinuationToken()
```
    NextContinuationToken is sent when isTruncated is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key
    
    Returns:
    
    NextContinuationToken is sent when isTruncated is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key
  - startAfter
```
public final String startAfter()
```
    If StartAfter was sent with the request, it is included in the response.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    If StartAfter was sent with the request, it is included in the response.
    
    This functionality is not supported for directory buckets.
  - requestCharged
```
public final RequestCharged requestCharged()
```
    Returns the value of the RequestCharged property for this object.
    If the service returns an enum value that is not available in the current SDK version, requestCharged will return RequestCharged.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestChargedAsString().
    
    Returns:
    
    The value of the RequestCharged property for this object.
    
    See Also:
    
    RequestCharged
  - requestChargedAsString
```
public final String requestChargedAsString()
```
    Returns the value of the RequestCharged property for this object.
    If the service returns an enum value that is not available in the current SDK version, requestCharged will return RequestCharged.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestChargedAsString().
    
    Returns:
    
    The value of the RequestCharged property for this object.
    
    See Also:
    
    RequestCharged
  - toBuilder
```
public ListObjectsV2Response.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<ListObjectsV2Response.Builder,ListObjectsV2Response>
    
    Specified by:
    
    toBuilder in class AwsResponse
    
    Returns:
    
    a builder for type T
  - builder
```
public static ListObjectsV2Response.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListObjectsV2Response.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - 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: SdkResponse
    
    Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkResponse
    
    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 ListObjectsV2Response

Nested Class Summary

Method Summary

Methods inherited from class com.ibm.cos.v2.services.s3.model.S3Response

Methods inherited from class com.ibm.cos.v2.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

isTruncated

hasContents

contents

name

prefix

delimiter

maxKeys

hasCommonPrefixes

commonPrefixes

encodingType

encodingTypeAsString

keyCount

continuationToken

nextContinuationToken

startAfter

requestCharged

requestChargedAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField