ListObjectsResponse (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.s3.model.S3Response
    - - software.amazon.awssdk.services.s3.model.ListObjectsResponse

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

@Generated(value="software.amazon.awssdk:codegen")
public final class ListObjectsResponse
extends S3Response
implements ToCopyableBuilder<ListObjectsResponse.Builder,ListObjectsResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ListObjectsResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ListObjectsResponse.Builder`	`builder()`
`List<CommonPrefix>`	`commonPrefixes()` Returns the value of the CommonPrefixes property for this object.
`List<S3Object>`	`contents()` Returns the value of the Contents property for this object.
`String`	`delimiter()` Returns the value of the Delimiter property for this object.
`EncodingType`	`encodingType()` Encoding type used by Amazon S3 to encode object keys in the response.
`String`	`encodingTypeAsString()` Encoding type used by Amazon S3 to encode object keys in the response.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkResponse`.
`int`	`hashCode()`
`Boolean`	`isTruncated()` A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.
`String`	`marker()` Returns the value of the Marker property for this object.
`Integer`	`maxKeys()` Returns the value of the MaxKeys property for this object.
`String`	`name()` Returns the value of the Name property for this object.
`String`	`nextMarker()` When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects.
`String`	`prefix()` Returns the value of the Prefix property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListObjectsResponse.Builder>`	`serializableBuilderClass()`
`ListObjectsResponse.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.services.s3.model.S3Response
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - isTruncated
```
public Boolean isTruncated()
```
    A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.
    
    Returns:
    
    A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.
  - marker
```
public String marker()
```
    Returns the value of the Marker property for this object.
    
    Returns:
    
    The value of the Marker property for this object.
  - nextMarker
```
public String nextMarker()
```
    When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMaker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.
    
    Returns:
    
    When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMaker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.
  - contents
```
public List<S3Object> contents()
```
    Returns the value of the Contents property for this object.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The value of the Contents property for this object.
  - name
```
public String name()
```
    Returns the value of the Name property for this object.
    
    Returns:
    
    The value of the Name property for this object.
  - prefix
```
public String prefix()
```
    Returns the value of the Prefix property for this object.
    
    Returns:
    
    The value of the Prefix property for this object.
  - delimiter
```
public String delimiter()
```
    Returns the value of the Delimiter property for this object.
    
    Returns:
    
    The value of the Delimiter property for this object.
  - maxKeys
```
public Integer maxKeys()
```
    Returns the value of the MaxKeys property for this object.
    
    Returns:
    
    The value of the MaxKeys property for this object.
  - commonPrefixes
```
public List<CommonPrefix> commonPrefixes()
```
    Returns the value of the CommonPrefixes property for this object.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The value of the CommonPrefixes property for this object.
  - encodingType
```
public EncodingType encodingType()
```
    Encoding type used by Amazon S3 to encode object keys in the response.
    
    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 keys in the response.
    
    See Also:
    
    EncodingType
  - encodingTypeAsString
```
public String encodingTypeAsString()
```
    Encoding type used by Amazon S3 to encode object keys in the response.
    
    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 keys in the response.
    
    See Also:
    
    EncodingType
  - toBuilder
```
public ListObjectsResponse.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<ListObjectsResponse.Builder,ListObjectsResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
    
    Returns:
    
    a builder for type T
  - builder
```
public static ListObjectsResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListObjectsResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <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 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.

Class ListObjectsResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.s3.model.S3Response

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

isTruncated

marker

nextMarker

contents

name

prefix

delimiter

maxKeys

commonPrefixes

encodingType

encodingTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields