ListObjectsV2Response (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.ListObjectsV2Response

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

@Generated(value="software.amazon.awssdk: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()` CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by delimiter
`List<S3Object>`	`contents()` Metadata about each object returned.
`String`	`continuationToken()` ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token.
`String`	`delimiter()` A delimiter is a character you use to group keys.
`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.
`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()` Name of the bucket to list.
`String`	`nextContinuationToken()` NextContinuationToken is sent when isTruncated is true which means there are more keys in the bucket that can be listed.
`String`	`prefix()` Limits the response to keys that begin with the specified prefix.
`static Class<? extends ListObjectsV2Response.Builder>`	`serializableBuilderClass()`
`String`	`startAfter()` StartAfter is where you want Amazon S3 to start listing from.
`ListObjectsV2Response.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.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.
  - contents
```
public List<S3Object> contents()
```
    Metadata about each object returned.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Metadata about each object returned.
  - name
```
public String name()
```
    Name of the bucket to list.
    
    Returns:
    
    Name of the bucket to list.
  - prefix
```
public String prefix()
```
    Limits the response to keys that begin with the specified prefix.
    
    Returns:
    
    Limits the response to keys that begin with the specified prefix.
  - delimiter
```
public String delimiter()
```
    A delimiter is a character you use to group keys.
    
    Returns:
    
    A delimiter is a character you use to group keys.
  - maxKeys
```
public Integer maxKeys()
```
    Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.
    
    Returns:
    
    Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.
  - commonPrefixes
```
public List<CommonPrefix> commonPrefixes()
```
    CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by delimiter
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by delimiter
  - 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
  - keyCount
```
public Integer keyCount()
```
    KeyCount is the number of keys returned with this request. KeyCount will always be less than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys
    
    Returns:
    
    KeyCount is the number of keys returned with this request. KeyCount will always be less than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys
  - continuationToken
```
public String continuationToken()
```
    ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key
    
    Returns:
    
    ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key
  - nextContinuationToken
```
public 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 String startAfter()
```
    StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket
    
    Returns:
    
    StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket
  - 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 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

Class ListObjectsV2Response

Nested Class Summary

Method Summary

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

contents

name

prefix

delimiter

maxKeys

commonPrefixes

encodingType

encodingTypeAsString

keyCount

continuationToken

nextContinuationToken

startAfter

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField