com.ibm.cloud.objectstorage.services.s3.model

Class ListBucketsExtendedRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

com.ibm.cloud.objectstorage.services.s3.model.ListBucketsExtendedRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

public class ListBucketsExtendedRequest
extends AmazonWebServiceRequest
implements Serializable

Request to retrieve a listing of buckets from Cloud Object Storage.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListBucketsExtendedRequest() Constructs a new ListBucketsExtendedRequest object
ListBucketsExtendedRequest(String prefix, String marker, Integer maxKeys) Constructs a new ListBucketsExtendedRequest object and initializes all required and optional object fields.

Method Summary

Modifier and Type	Method and Description
String	getMarker() Gets the optional marker parameter indicating where in the bucket to begin listing.
Integer	getMaxKeys() Gets the optional maxKeys parameter indicating the maximum number of keys to include in the response.
String	getPrefix() Gets the optional prefix parameter and restricts the response to keys that begin with the specified prefix.
void	setMarker(String marker) Sets the optional marker parameter indicating where to begin listing.
void	setMaxKeys(Integer maxKeys) Sets the optional maxKeys parameter indicating the maximum number of keys to include in the response.
void	setPrefix(String prefix) Sets the optional prefix parameter, restricting the response to keys that begin with the specified prefix.
ListBucketsExtendedRequest	withMarker(String marker) Sets the optional marker parameter indicating where to begin listing.
ListBucketsExtendedRequest	withMaxKeys(Integer maxKeys) Sets the optional maxKeys parameter indicating the maximum number of keys to include in the response.
ListBucketsExtendedRequest	withPrefix(String prefix) Sets the optional prefix parameter restricting the response to keys that begin with the specified prefix.

Methods inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest

addHandlerContext, clone, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListBucketsExtendedRequest

public ListBucketsExtendedRequest(String prefix,
                                  String marker,
                                  Integer maxKeys)

Constructs a new ListBucketsExtendedRequest object and initializes all required and optional object fields.

Parameters:

prefix - The prefix restricting what keys will be listed.

marker - The key marker indicating where listing results should begin.

maxKeys - The maximum number of results to return.

See Also:

ListBucketsExtendedRequest()

ListBucketsExtendedRequest

public ListBucketsExtendedRequest()

Constructs a new ListBucketsExtendedRequest object

See Also:

ListObjectsRequest()

Method Detail

getMaxKeys

public Integer getMaxKeys()

Gets the optional maxKeys parameter indicating the maximum number of keys to include in the response. COS S3 might return fewer keys than specified, but will never return more.

Returns:

The optional parameter indicating the maximum number of keys to include in the response.

setMaxKeys

public void setMaxKeys(Integer maxKeys)

Sets the optional maxKeys parameter indicating the maximum number of keys to include in the response.

Parameters:

maxKeys - The optional parameter indicating the maximum number of keys to include in the response.

withMaxKeys

public ListBucketsExtendedRequest withMaxKeys(Integer maxKeys)

Sets the optional maxKeys parameter indicating the maximum number of keys to include in the response. Returns this ListBucketsExtendedRequest, enabling additional method calls to be chained together.

Parameters:

maxKeys - The optional parameter indicating the maximum number of keys to include in the response.

Returns:

This ListBucketsExtendedRequest, enabling additional method calls to be chained together.

See Also:

ListBucketsExtendedRequest.getMaxKeys(), ListBucketsExtendedRequest.setMaxKeys(Integer)

getPrefix

public String getPrefix()

Gets the optional prefix parameter and restricts the response to keys that begin with the specified prefix. Use prefixes to separate a bucket into different sets of keys, similar to how a file system organizes files into directories.

Returns:

The optional prefix parameter restricting the response to keys that begin with the specified prefix.

See Also:

ListBucketsExtendedRequest.setPrefix(String)

setPrefix

public void setPrefix(String prefix)

Sets the optional prefix parameter, restricting the response to keys that begin with the specified prefix.

Parameters:

prefix - The optional prefix parameter, restricting the response to keys that begin with the specified prefix.

See Also:

ListBucketsExtendedRequest.getPrefix()

withPrefix

public ListBucketsExtendedRequest withPrefix(String prefix)

Sets the optional prefix parameter restricting the response to keys that begin with the specified prefix. Returns this ListBucketsExtendedRequest, enabling additional method calls to be chained together.

Parameters:

prefix - The optional prefix parameter restricting the response to keys that begin with the specified prefix.

Returns:

This ListBucketsExtendedRequest, enabling additional method calls to be chained together.

See Also:

ListBucketsExtendedRequest.getPrefix(), ListBucketsExtendedRequest.setPrefix(String)

getMarker

public String getMarker()

Gets the optional marker parameter indicating where in the bucket to begin listing. The list will only include keys that occur lexicographically after the marker.

Returns:

The optional marker parameter indicating where in the bucket to begin listing. The list will only include keys that occur lexicographically after the marker.

See Also:

ListBucketsExtendedRequest.setMarker(String), ListBucketsExtendedRequest.withMarker(String)

setMarker

public void setMarker(String marker)

Sets the optional marker parameter indicating where to begin listing. The list will only include keys that occur lexicographically after the marker.

Parameters:

marker - The optional marker parameter indicating where in the bucket to begin listing. The list will only include keys that occur lexicographically after the marker.

See Also:

ListBucketsExtendedRequest.getMarker(), ListBucketsExtendedRequest.withMarker(String)

withMarker

public ListBucketsExtendedRequest withMarker(String marker)

Sets the optional marker parameter indicating where to begin listing. Returns this ListBucketsExtendedRequest, enabling additional method calls to be chained together. The list will only include keys that occur lexicographically after the marker.

Parameters:

marker - The optional parameter indicating where in the bucket to begin listing. The list will only include keys that occur lexicographically after the marker.

Returns:

This ListBucketsExtendedRequest, enabling additional method calls to be chained together.

See Also:

ListBucketsExtendedRequest.getMarker(), ListBucketsExtendedRequest.setMarker(String)