ListObjectsV2Request (AWS Java SDK :: Services

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:: SdkPojo, 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()` Bucket name 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`	`equalsBySdkFields(Object obj)`
`String`	`expectedBucketOwner()` The account id of the expected bucket owner.
`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)`
`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.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListObjectsV2Request.Builder>`	`serializableBuilderClass()`
`String`	`startAfter()` StartAfter is where you want Amazon S3 to start listing from.
`ListObjectsV2Request.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

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
  - bucket
```
public String bucket()
```
    Bucket name to list.
    
    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 using 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.
    
    Returns:
    
    Bucket name to list.
    
    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 using 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.
  - 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. 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.
  - 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
  - expectedBucketOwner
```
public String expectedBucketOwner()
```
    The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
    
    Returns:
    
    The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
  - toBuilder
```
public ListObjectsV2Request.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListObjectsV2Request.Builder,ListObjectsV2Request>
    
    Specified by:
    
    toBuilder in class S3Request
  - builder
```
public static ListObjectsV2Request.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListObjectsV2Request.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

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

expectedBucketOwner

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields