ListObjectsV2Response (AWS Java SDK :: Services

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:: SdkPojo, 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()` All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.
`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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCommonPrefixes()` Returns true if the CommonPrefixes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasContents()` Returns true if the Contents property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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.
`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()`
`String`	`toString()` Returns a string representation of this object.

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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.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()
```
    Returns true if the Contents property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasContents() to see if a value was sent in this field.
    
    Returns:
    
    Metadata about each object returned.
  - name
```
public final String name()
```
    The bucket name.
    
    When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
    
    When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
    
    Returns:
    
    The bucket name.
    
    When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
    
    When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
  - prefix
```
public final String prefix()
```
    Keys that begin with the indicated prefix.
    
    Returns:
    
    Keys that begin with the indicated prefix.
  - 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.
    
    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.
  - maxKeys
```
public final Integer maxKeys()
```
    Sets the maximum number of keys returned in the response. By default the API 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 API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.
  - hasCommonPrefixes
```
public final boolean hasCommonPrefixes()
```
    Returns true if the CommonPrefixes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - commonPrefixes
```
public final List<CommonPrefix> commonPrefixes()
```
    All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.
    
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasCommonPrefixes() to see if a value was sent in this field.
    
    Returns:
    
    All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.
    
    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.
  - 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 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 final String continuationToken()
```
    If ContinuationToken was sent with the request, it is included in the response.
    
    Returns:
    
    If ContinuationToken was sent with the request, it is included in the response.
  - 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.
    
    Returns:
    
    If StartAfter was sent with the request, it is included in the response.
  - toBuilder
```
public ListObjectsV2Response.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListObjectsV2Response.Builder,ListObjectsV2Response>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ListObjectsV2Response

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

hasContents

contents

name

prefix

delimiter

maxKeys

hasCommonPrefixes

commonPrefixes

encodingType

encodingTypeAsString

keyCount

continuationToken

nextContinuationToken

startAfter

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields