com.obs.services.model

Class ObjectListing

java.lang.Object

com.obs.services.internal.InternalHeaderResponse

com.obs.services.model.HeaderResponse

com.obs.services.model.ObjectListing

public class ObjectListing
extends HeaderResponse

Response to a request for listing objects in a bucket

Field Summary

Fields inherited from class com.obs.services.internal.InternalHeaderResponse

responseHeaders, statusCode

Constructor Summary

Constructors

Constructor and Description
ObjectListing(List<ObsObject> objectSummaries, List<String> commonPrefixes, String bucketName, boolean truncated, String prefix, String marker, int maxKeys, String delimiter, String nextMarker, String location)

Method Summary

Methods

Modifier and Type	Method and Description
String	getBucketName() Obtain the bucket name.
List<String>	getCommonPrefixes() Obtain the list of prefixes to the names of grouped objects.
String	getDelimiter() Obtain the character for grouping object names.
String	getLocation() Obtain the bucket location.
String	getMarker() Obtain the start position for listing objects.
int	getMaxKeys() Obtain the maximum number of objects to be listed.
String	getNextMarker() Obtain the start position for next listing.
List<ObsObject>	getObjects() Obtain the list of objects in the bucket.
List<S3Object>	getObjectSummaries() Deprecated.
String	getPrefix() Obtain the object name prefix used for filtering objects to be listed.
boolean	isTruncated() Check whether the query result list is truncated.
String	toString()

Methods inherited from class com.obs.services.model.HeaderResponse

getRequestId, getResponseHeaders, getStatusCode

Methods inherited from class com.obs.services.internal.InternalHeaderResponse

setResponseHeaders, setStatusCode

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectListing

public ObjectListing(List<ObsObject> objectSummaries,
             List<String> commonPrefixes,
             String bucketName,
             boolean truncated,
             String prefix,
             String marker,
             int maxKeys,
             String delimiter,
             String nextMarker,
             String location)

Method Detail

getNextMarker

public String getNextMarker()

Obtain the start position for next listing.

Returns:

Start position for next listing

getObjects

public List<ObsObject> getObjects()

Obtain the list of objects in the bucket.

Returns:

List of objects in the bucket

getObjectSummaries

@Deprecated
public List<S3Object> getObjectSummaries()

Deprecated.

getCommonPrefixes

public List<String> getCommonPrefixes()

Obtain the list of prefixes to the names of grouped objects.

Returns:

List of prefixes to the names of grouped objects

getBucketName

public String getBucketName()

Obtain the bucket name.

Returns:

Bucket name

isTruncated

public boolean isTruncated()

Check whether the query result list is truncated. Value "true" indicates that the results are incomplete while value "false" indicates that the results are complete.

Returns:

Truncation identifier

getPrefix

public String getPrefix()

Obtain the object name prefix used for filtering objects to be listed.

Returns:

Object name prefix used for listing versioning objects

getMarker

public String getMarker()

Obtain the start position for listing objects.

Returns:

Start position for listing objects

getMaxKeys

public int getMaxKeys()

Obtain the maximum number of objects to be listed.

Returns:

Maximum number of objects to be listed

getDelimiter

public String getDelimiter()

Obtain the character for grouping object names.

Returns:

Character for grouping object names

getLocation

public String getLocation()

Obtain the bucket location.

Returns:

Bucket location

toString

public String toString()

Overrides:

toString in class HeaderResponse