Interface ListObjectsV2Response.Builder
-
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<ListObjectsV2Response.Builder,ListObjectsV2Response>
,S3Response.Builder
,SdkBuilder<ListObjectsV2Response.Builder,ListObjectsV2Response>
,SdkPojo
,SdkResponse.Builder
- Enclosing class:
- ListObjectsV2Response
public static interface ListObjectsV2Response.Builder extends S3Response.Builder, SdkPojo, CopyableBuilder<ListObjectsV2Response.Builder,ListObjectsV2Response>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ListObjectsV2Response.Builder
commonPrefixes(Collection<CommonPrefix> commonPrefixes)
All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating the number of returns.ListObjectsV2Response.Builder
commonPrefixes(Consumer<CommonPrefix.Builder>... commonPrefixes)
All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating the number of returns.ListObjectsV2Response.Builder
commonPrefixes(CommonPrefix... commonPrefixes)
All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating the number of returns.ListObjectsV2Response.Builder
contents(Collection<S3Object> contents)
Metadata about each object returned.ListObjectsV2Response.Builder
contents(Consumer<S3Object.Builder>... contents)
Metadata about each object returned.ListObjectsV2Response.Builder
contents(S3Object... contents)
Metadata about each object returned.ListObjectsV2Response.Builder
continuationToken(String continuationToken)
IfContinuationToken
was sent with the request, it is included in the response.ListObjectsV2Response.Builder
delimiter(String delimiter)
Causes keys that contain the same string between theprefix
and the first occurrence of the delimiter to be rolled up into a single result element in theCommonPrefixes
collection.ListObjectsV2Response.Builder
encodingType(String encodingType)
Encoding type used by Amazon S3 to encode object key names in the XML response.ListObjectsV2Response.Builder
encodingType(EncodingType encodingType)
Encoding type used by Amazon S3 to encode object key names in the XML response.ListObjectsV2Response.Builder
isTruncated(Boolean isTruncated)
Set tofalse
if all of the results were returned.ListObjectsV2Response.Builder
keyCount(Integer keyCount)
KeyCount
is the number of keys returned with this request.ListObjectsV2Response.Builder
maxKeys(Integer maxKeys)
Sets the maximum number of keys returned in the response.ListObjectsV2Response.Builder
name(String name)
The bucket name.ListObjectsV2Response.Builder
nextContinuationToken(String nextContinuationToken)
NextContinuationToken
is sent whenisTruncated
is true, which means there are more keys in the bucket that can be listed.ListObjectsV2Response.Builder
prefix(String prefix)
Keys that begin with the indicated prefix.ListObjectsV2Response.Builder
requestCharged(String requestCharged)
Sets the value of the RequestCharged property for this object.ListObjectsV2Response.Builder
requestCharged(RequestCharged requestCharged)
Sets the value of the RequestCharged property for this object.ListObjectsV2Response.Builder
startAfter(String startAfter)
If StartAfter was sent with the request, it is included in the response.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.s3.model.S3Response.Builder
build, responseMetadata, responseMetadata
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
-
-
-
Method Detail
-
isTruncated
ListObjectsV2Response.Builder isTruncated(Boolean isTruncated)
Set to
false
if all of the results were returned. Set totrue
if more keys are available to return. If the number of results exceeds that specified byMaxKeys
, all of the results might not be returned.- Parameters:
isTruncated
- Set tofalse
if all of the results were returned. Set totrue
if more keys are available to return. If the number of results exceeds that specified byMaxKeys
, all of the results might not be returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
contents
ListObjectsV2Response.Builder contents(Collection<S3Object> contents)
Metadata about each object returned.
- Parameters:
contents
- Metadata about each object returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
contents
ListObjectsV2Response.Builder contents(S3Object... contents)
Metadata about each object returned.
- Parameters:
contents
- Metadata about each object returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
contents
ListObjectsV2Response.Builder contents(Consumer<S3Object.Builder>... contents)
Metadata about each object returned.
This is a convenience method that creates an instance of theS3Object.Builder
avoiding the need to create one manually viaS3Object.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#contents(List
.) - Parameters:
contents
- a consumer that will call methods onS3Object.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#contents(java.util.Collection
)
-
name
ListObjectsV2Response.Builder name(String name)
The bucket name.
When using this action 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 action with an access point through the Amazon Web Services 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 S3 User Guide.
When you use this action 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.- Parameters:
name
- The bucket name.When using this action 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 action with an access point through the Amazon Web Services 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 S3 User Guide.
When you use this action 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
prefix
ListObjectsV2Response.Builder prefix(String prefix)
Keys that begin with the indicated prefix.
- Parameters:
prefix
- Keys that begin with the indicated prefix.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
delimiter
ListObjectsV2Response.Builder delimiter(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 theCommonPrefixes
collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against theMaxKeys
value.- Parameters:
delimiter
- Causes keys that contain the same string between theprefix
and the first occurrence of the delimiter to be rolled up into a single result element in theCommonPrefixes
collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against theMaxKeys
value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxKeys
ListObjectsV2Response.Builder maxKeys(Integer maxKeys)
Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.
- Parameters:
maxKeys
- Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
commonPrefixes
ListObjectsV2Response.Builder commonPrefixes(Collection<CommonPrefix> commonPrefixes)
All of the keys (up to 1,000) 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 betweenPrefix
and the next occurrence of the string specified by a delimiter.CommonPrefixes
lists keys that act like subdirectories in the directory specified byPrefix
.For example, if the prefix is
notes/
and the delimiter is a slash (/
) as innotes/summer/july
, the common prefix isnotes/summer/
. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.- Parameters:
commonPrefixes
- All of the keys (up to 1,000) 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 betweenPrefix
and the next occurrence of the string specified by a delimiter.CommonPrefixes
lists keys that act like subdirectories in the directory specified byPrefix
.For example, if the prefix is
notes/
and the delimiter is a slash (/
) as innotes/summer/july
, the common prefix isnotes/summer/
. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
commonPrefixes
ListObjectsV2Response.Builder commonPrefixes(CommonPrefix... commonPrefixes)
All of the keys (up to 1,000) 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 betweenPrefix
and the next occurrence of the string specified by a delimiter.CommonPrefixes
lists keys that act like subdirectories in the directory specified byPrefix
.For example, if the prefix is
notes/
and the delimiter is a slash (/
) as innotes/summer/july
, the common prefix isnotes/summer/
. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.- Parameters:
commonPrefixes
- All of the keys (up to 1,000) 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 betweenPrefix
and the next occurrence of the string specified by a delimiter.CommonPrefixes
lists keys that act like subdirectories in the directory specified byPrefix
.For example, if the prefix is
notes/
and the delimiter is a slash (/
) as innotes/summer/july
, the common prefix isnotes/summer/
. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
commonPrefixes
ListObjectsV2Response.Builder commonPrefixes(Consumer<CommonPrefix.Builder>... commonPrefixes)
All of the keys (up to 1,000) 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 betweenPrefix
and the next occurrence of the string specified by a delimiter.CommonPrefixes
lists keys that act like subdirectories in the directory specified byPrefix
.For example, if the prefix is
This is a convenience method that creates an instance of thenotes/
and the delimiter is a slash (/
) as innotes/summer/july
, the common prefix isnotes/summer/
. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.CommonPrefix.Builder
avoiding the need to create one manually viaCommonPrefix.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#commonPrefixes(List
.) - Parameters:
commonPrefixes
- a consumer that will call methods onCommonPrefix.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#commonPrefixes(java.util.Collection
)
-
encodingType
ListObjectsV2Response.Builder encodingType(String 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,
andStartAfter
.- Parameters:
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,
andStartAfter
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
EncodingType
,EncodingType
-
encodingType
ListObjectsV2Response.Builder encodingType(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,
andStartAfter
.- Parameters:
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,
andStartAfter
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
EncodingType
,EncodingType
-
keyCount
ListObjectsV2Response.Builder keyCount(Integer keyCount)
KeyCount
is the number of keys returned with this request.KeyCount
will always be less than or equal to theMaxKeys
field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.- Parameters:
keyCount
-KeyCount
is the number of keys returned with this request.KeyCount
will always be less than or equal to theMaxKeys
field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
continuationToken
ListObjectsV2Response.Builder continuationToken(String continuationToken)
If
ContinuationToken
was sent with the request, it is included in the response.- Parameters:
continuationToken
- IfContinuationToken
was sent with the request, it is included in the response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextContinuationToken
ListObjectsV2Response.Builder nextContinuationToken(String nextContinuationToken)
NextContinuationToken
is sent whenisTruncated
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 thisNextContinuationToken
.NextContinuationToken
is obfuscated and is not a real key- Parameters:
nextContinuationToken
-NextContinuationToken
is sent whenisTruncated
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 thisNextContinuationToken
.NextContinuationToken
is obfuscated and is not a real key- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startAfter
ListObjectsV2Response.Builder startAfter(String startAfter)
If StartAfter was sent with the request, it is included in the response.
- Parameters:
startAfter
- If StartAfter was sent with the request, it is included in the response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
requestCharged
ListObjectsV2Response.Builder requestCharged(String requestCharged)
Sets the value of the RequestCharged property for this object.- Parameters:
requestCharged
- The new value for the RequestCharged property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
RequestCharged
,RequestCharged
-
requestCharged
ListObjectsV2Response.Builder requestCharged(RequestCharged requestCharged)
Sets the value of the RequestCharged property for this object.- Parameters:
requestCharged
- The new value for the RequestCharged property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
RequestCharged
,RequestCharged
-
-