com.emc.atmos.api.request

Class ListObjectsRequest

java.lang.Object

com.emc.atmos.api.request.Request

com.emc.atmos.api.request.ListRequest<T>

com.emc.atmos.api.request.ListMetadataRequest<ListObjectsRequest>

com.emc.atmos.api.request.ListObjectsRequest

public class ListObjectsRequest
extends ListMetadataRequest<ListObjectsRequest>

Represents a request to list/query the objects of a specific listable metadata name (tag).

Field Summary

Fields inherited from class com.emc.atmos.api.request.ListMetadataRequest

includeMetadata, systemMetadataNames, userMetadataNames

Fields inherited from class com.emc.atmos.api.request.ListRequest

limit, token

Constructor Summary

Constructors

Constructor and Description
ListObjectsRequest()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.List<java.lang.Object>>	generateHeaders(boolean encodeUtf8) Returns the HTTP headers to send in this request, to be generated from other request properties immediately before sending.
java.lang.String	getMetadataName() Gets the metadata name (tag) to query.
java.lang.String	getMethod() Returns the HTTP method this request will use.
java.lang.String	getServiceRelativePath() Returns the service-relative path of this request (i.e.
protected ListObjectsRequest	me() Returns "this" in concrete implementation classes.
ListObjectsRequest	metadataName(java.lang.String metadataName) Builder method for setMetadataName(String)
void	setMetadataName(java.lang.String metadataName) Sets the metadata name (tag) to query.

Methods inherited from class com.emc.atmos.api.request.ListMetadataRequest

getSystemMetadataNames, getUserMetadataNames, includeMetadata, isIncludeMetadata, setIncludeMetadata, setSystemMetadataNames, setUserMetadataNames, systemMetadataNames, userMetadataNames

Methods inherited from class com.emc.atmos.api.request.ListRequest

getLimit, getToken, limit, setLimit, setToken, token

Methods inherited from class com.emc.atmos.api.request.Request

getQuery, supports100Continue

Methods inherited from class java.lang.Object

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

Constructor Detail

ListObjectsRequest

public ListObjectsRequest()

Method Detail

getServiceRelativePath

public java.lang.String getServiceRelativePath()

Description copied from class: Request

Returns the service-relative path of this request (i.e. "objects/{identifier}" for read-object).

Specified by:

getServiceRelativePath in class Request

getMethod

public java.lang.String getMethod()

Description copied from class: Request

Returns the HTTP method this request will use.

Specified by:

getMethod in class Request

generateHeaders

public java.util.Map<java.lang.String,java.util.List<java.lang.Object>> generateHeaders(boolean encodeUtf8)

Description copied from class: Request

Returns the HTTP headers to send in this request, to be generated from other request properties immediately before sending.

Overrides:

generateHeaders in class ListMetadataRequest<ListObjectsRequest>

me

protected ListObjectsRequest me()

Description copied from class: ListRequest

Returns "this" in concrete implementation classes. Used in builder methods to be consistent throughout the hierarchy. For example, you can call new CreateObjectRequest().identifier(path).content(content).

Specified by:

me in class ListRequest<ListObjectsRequest>

Returns:

this

metadataName

public ListObjectsRequest metadataName(java.lang.String metadataName)

Builder method for setMetadataName(String)

getMetadataName

public java.lang.String getMetadataName()

Gets the metadata name (tag) to query.

setMetadataName

public void setMetadataName(java.lang.String metadataName)

Sets the metadata name (tag) to query. Atmos will return all of the objects that are assigned this exact tag.