com.emc.atmos.api.request

Class ListMetadataRequest<T extends ListMetadataRequest<T>>

java.lang.Object

com.emc.atmos.api.request.Request

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

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

Type Parameters:

T - Represents the implementation type. Allows a consistent builder interface throughout the request hierarchy. Parameterize concrete subclasses with their own type and implement ListRequest.me() to return "this". In abstract subclasses, return me() in builder methods.

Direct Known Subclasses:

ListDirectoryRequest, ListObjectsRequest

public abstract class ListMetadataRequest<T extends ListMetadataRequest<T>>
extends ListRequest<T>

Represents common elements of list requests that may include object metadata.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	includeMetadata
protected java.util.List<java.lang.String>	systemMetadataNames
protected java.util.List<java.lang.String>	userMetadataNames

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

limit, token

Constructor Summary

Constructors

Constructor and Description
ListMetadataRequest()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.List<java.lang.Object>>	generateHeaders() Returns the HTTP headers to send in this request, to be generated from other request properties immediately before sending.
java.util.List<java.lang.String>	getSystemMetadataNames() Gets the list of system metadata names that will be returned for each object in the list.
java.util.List<java.lang.String>	getUserMetadataNames() Gets the list of user metadata names that will be returned for each object in the list.
T	includeMetadata(boolean includeMetadata) Builder method for setIncludeMetadata(boolean)
boolean	isIncludeMetadata() Gets whether the resulting list should include metadata for each object.
void	setIncludeMetadata(boolean includeMetadata) Sets whether the resulting list should include metadata for each object.
void	setSystemMetadataNames(java.util.List<java.lang.String> systemMetadataNames) Sets the list of system metadata names that will be returned for each object in the list.
void	setUserMetadataNames(java.util.List<java.lang.String> userMetadataNames) Sets the list of user metadata names that will be returned for each object in the list.
T	systemMetadataNames(java.lang.String... systemMetadataNames) Builder method for setSystemMetadataNames(java.util.List)
T	userMetadataNames(java.lang.String... userMetadataNames) Builder method for setUserMetadataNames(java.util.List)

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

getLimit, getToken, limit, me, setLimit, setToken, token

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

getMethod, getQuery, getServiceRelativePath, supports100Continue

Methods inherited from class java.lang.Object

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

Field Detail

userMetadataNames

protected java.util.List<java.lang.String> userMetadataNames

systemMetadataNames

protected java.util.List<java.lang.String> systemMetadataNames

includeMetadata

protected boolean includeMetadata

Constructor Detail

ListMetadataRequest

public ListMetadataRequest()

Method Detail

generateHeaders

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

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 ListRequest<T extends ListMetadataRequest<T>>

userMetadataNames

public T userMetadataNames(java.lang.String... userMetadataNames)

Builder method for setUserMetadataNames(java.util.List)

systemMetadataNames

public T systemMetadataNames(java.lang.String... systemMetadataNames)

Builder method for setSystemMetadataNames(java.util.List)

includeMetadata

public T includeMetadata(boolean includeMetadata)

Builder method for setIncludeMetadata(boolean)

getUserMetadataNames

public java.util.List<java.lang.String> getUserMetadataNames()

Gets the list of user metadata names that will be returned for each object in the list.

getSystemMetadataNames

public java.util.List<java.lang.String> getSystemMetadataNames()

Gets the list of system metadata names that will be returned for each object in the list.

isIncludeMetadata

public boolean isIncludeMetadata()

Gets whether the resulting list should include metadata for each object.

setUserMetadataNames

public void setUserMetadataNames(java.util.List<java.lang.String> userMetadataNames)

Sets the list of user metadata names that will be returned for each object in the list. If null, all user metadata will be returned for each object in the list.

setSystemMetadataNames

public void setSystemMetadataNames(java.util.List<java.lang.String> systemMetadataNames)

Sets the list of system metadata names that will be returned for each object in the list. If null, all system metadata will be returned for each object in the list.

setIncludeMetadata

public void setIncludeMetadata(boolean includeMetadata)

Sets whether the resulting list should include metadata for each object. Note that the default page size for result lists changes when you include metadata in the results. Most Atmos systems default to 10k objects per page without metadata and 500 with.