ListObjectsV2Request (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.s3.model.S3Request
    - - software.amazon.awssdk.services.s3.model.ListObjectsV2Request

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ListObjectsV2Request.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`bucket()` Name of the bucket to list.
`static ListObjectsV2Request.Builder`	`builder()`
`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)`
`Boolean`	`fetchOwner()` The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true
`<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()`
`Integer`	`maxKeys()` Sets the maximum number of keys returned in the response.
`String`	`prefix()` Limits the response to keys that begin with the specified prefix.
`RequestPayer`	`requestPayer()` Confirms that the requester knows that she or he will be charged for the list objects request in V2 style.
`String`	`requestPayerAsString()` Confirms that the requester knows that she or he will be charged for the list objects request in V2 style.
`static Class<? extends ListObjectsV2Request.Builder>`	`serializableBuilderClass()`
`String`	`startAfter()` StartAfter is where you want Amazon S3 to start listing from.
`ListObjectsV2Request.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.awscore.AwsRequest
overrideConfiguration

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
  - bucket
```
public String bucket()
```
    Name of the bucket to list.
    
    Returns:
    
    Name of the bucket to list.
  - 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.
  - 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
  - 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.
  - 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.
  - 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
  - fetchOwner
```
public Boolean fetchOwner()
```
    The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true
    
    Returns:
    
    The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true
  - 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
  - requestPayer
```
public RequestPayer requestPayer()
```
    Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.
    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:
    
    Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.
    
    See Also:
    
    RequestPayer
  - requestPayerAsString
```
public String requestPayerAsString()
```
    Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.
    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:
    
    Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.
    
    See Also:
    
    RequestPayer
  - toBuilder
```
public ListObjectsV2Request.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<ListObjectsV2Request.Builder,ListObjectsV2Request>
    
    Specified by:
    
    toBuilder in class S3Request
    
    Returns:
    
    a builder for type T
  - builder
```
public static ListObjectsV2Request.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListObjectsV2Request.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: 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

Class ListObjectsV2Request

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

bucket

delimiter

encodingType

encodingTypeAsString

maxKeys

prefix

continuationToken

fetchOwner

startAfter

requestPayer

requestPayerAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField