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

Class ListBucketsExtendedResponse

java.lang.Object

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

All Implemented Interfaces:

Serializable

public class ListBucketsExtendedResponse
extends Object
implements Serializable

Results of a listing of objects from an S3 bucket.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListBucketsExtendedResponse()

Method Summary

Modifier and Type	Method and Description
List<Bucket>	getBuckets() Gets the list of buckets describing the objects stored in the S3 bucket.
String	getMarker() Parameter indicating where in the bucket to begin listing.
boolean	isTruncated() Gets whether or not this listing is complete.
void	setBuckets(List<Bucket> buckets) For internal use only.
void	setMarker(String marker) For internal use only.
void	setTruncated(boolean isTruncated) For internal use only.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListBucketsExtendedResponse

public ListBucketsExtendedResponse()

Method Detail

isTruncated

public boolean isTruncated()

Gets whether or not this listing is complete.

Returns:

The value true if the bucket listing is not complete. Returns the value false if otherwise. When returning true, additional calls to COS may be needed in order to obtain more results.

setTruncated

public void setTruncated(boolean isTruncated)

For internal use only. Sets the truncated property for this object listing, indicating if this is a complete listing or not and whether the caller needs to make additional calls to S3 to get more object summaries.

Parameters:

isTruncated - The value true if the object listing is not complete. The value false if otherwise.

getBuckets

public List<Bucket> getBuckets()

Gets the list of buckets describing the objects stored in the S3 bucket. Listings for large buckets can be truncated for performance reasons. Always check the ListBucketsExtendedResponse.isTruncated() method to see if the returned listing is complete or if additional calls are needed to get more results.

Returns:

A list of buckets.

setBuckets

public void setBuckets(List<Bucket> buckets)

For internal use only. Sets the bucket from the XML response.

getMarker

public String getMarker()

Parameter indicating where in the bucket to begin listing. The list will only include keys that occur lexicographically after the marker. This enables pagination

Returns:

marker

setMarker

public void setMarker(String marker)

For internal use only. Sets the marker from the XML response.