com.spectralogic.ds3client.commands

Class GetBucketRequest

java.lang.Object

com.spectralogic.ds3client.commands.GetBucketRequest

All Implemented Interfaces:

Ds3Request

public class GetBucketRequest
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
GetBucketRequest(java.lang.String bucket)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBucket()
Checksum	getChecksum()
org.apache.http.entity.ContentType	getContentType()
java.lang.String	getDelimiter()
java.util.Map<java.lang.String,java.lang.String>	getHeaders()
int	getMaxKeys()
java.lang.String	getNextMarker()
java.lang.String	getPath()
java.lang.String	getPrefix()
java.util.Map<java.lang.String,java.lang.String>	getQueryParams()
long	getSize()
java.io.InputStream	getStream()
HttpVerb	getVerb()
GetBucketRequest	withDelimiter(java.lang.String delimiter)
GetBucketRequest	withMaxKeys(int maxKeys) Limit how many objects will be returned in a request before pagination is enforced.
GetBucketRequest	withNextMarker(java.lang.String nextMarker) If a GetBucketRequest has been paginated this method is used to get the next set of objects.
GetBucketRequest	withPrefix(java.lang.String prefix) Use the prefix method for getting a list of 'directories' without getting the objects within that directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

GetBucketRequest

public GetBucketRequest(java.lang.String bucket)

Parameters:

bucket - The name of the bucket that will have it's objects listed.

Method Detail

withNextMarker

public GetBucketRequest withNextMarker(java.lang.String nextMarker)

If a GetBucketRequest has been paginated this method is used to get the next set of objects.

Parameters:

nextMarker - The marker specified in GetBucketResponse.getResult()

Returns:

The current request object.

withPrefix

public GetBucketRequest withPrefix(java.lang.String prefix)

Use the prefix method for getting a list of 'directories' without getting the objects within that directory. For example to get the root level directories the prefix should be set to '/'

Parameters:

prefix - The prefix to filter the objects for.

Returns:

The current request object.

withMaxKeys

public GetBucketRequest withMaxKeys(int maxKeys)

Limit how many objects will be returned in a request before pagination is enforced.

Parameters:

maxKeys - The number of objects to request in a single request from DS3.

Returns:

The current request object.

withDelimiter

public GetBucketRequest withDelimiter(java.lang.String delimiter)

getBucket

public java.lang.String getBucket()

getNextMarker

public java.lang.String getNextMarker()

getPrefix

public java.lang.String getPrefix()

getMaxKeys

public int getMaxKeys()

getPath

public java.lang.String getPath()

getVerb

public HttpVerb getVerb()

getDelimiter

public java.lang.String getDelimiter()

getContentType

public org.apache.http.entity.ContentType getContentType()

Specified by:

getContentType in interface Ds3Request

getStream

public java.io.InputStream getStream()

Specified by:

getStream in interface Ds3Request

getSize

public long getSize()

Specified by:

getSize in interface Ds3Request

getChecksum

public Checksum getChecksum()

Specified by:

getChecksum in interface Ds3Request

getQueryParams

public final java.util.Map<java.lang.String,java.lang.String> getQueryParams()

Specified by:

getQueryParams in interface Ds3Request

getHeaders

public final java.util.Map<java.lang.String,java.lang.String> getHeaders()

Specified by:

getHeaders in interface Ds3Request