com.netease.cloud.services.nos.model.ObjectListing Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nos-sdk-java-publiccloud Show documentation
nos java sdk to the Central Repository
The newest version!
package com.netease.cloud.services.nos.model;

import java.util.ArrayList;
import java.util.List;

/**
 * Contains the results of listing the objects in an Nos bucket. This includes a
 * list of {@link NOSObjectSummary} objects describing the objects stored in the
 * bucket, a list of common prefixes if a delimiter was specified in the
 * request, information describing if this is a complete or partial listing, and
 * the original request parameters.
 * 
 */
public class ObjectListing {

	/**
	 * A list of summary information describing the objects stored in the bucket
	 */
	private List objectSummaries = new ArrayList();

	/**
	 * A list of the common prefixes included in this object listing - common
	 * prefixes will only be populated for requests that specified a delimiter
	 */
	private List commonPrefixes = new ArrayList();

	/** The name of the Nos bucket containing the listed objects */
	private String bucketName;

	/**
	 * The marker to use in order to request the next page of results - only
	 * populated if the isTruncated member indicates that this object listing is
	 * truncated
	 */
	private String nextMarker;

	/**
	 * Indicates if this is a complete listing, or if the caller needs to make
	 * additional requests to Nos to see the full object listing for an Nos
	 * bucket
	 */
	private boolean isTruncated;

	/* Original Request Parameters */

	/**
	 * The prefix parameter originally specified by the caller when this object
	 * listing was returned
	 */
	private String prefix;

	/**
	 * The marker parameter originally specified by the caller when this object
	 * listing was returned
	 */
	private String marker;

	/**
	 * The maxKeys parameter originally specified by the caller when this object
	 * listing was returned
	 */
	private int maxKeys;

	/**
	 * The delimiter parameter originally specified by the caller when this
	 * object listing was returned
	 */
	private String delimiter;

	/**
	 * Gets the list of object summaries describing the objects stored in the
	 * Nos bucket. Listings for large buckets can be truncated for performance
	 * reasons. Always check the {@link ObjectListing#isTruncated()} method to
	 * see if the returned listing is complete or if additional calls are needed
	 * to get more results.
	 * 
	 * @return A list of the object summaries describing the objects stored in
	 *         the Nos bucket.
	 */
	public List getObjectSummaries() {
		return objectSummaries;
	}

	/**
	 * 
	 * Gets the common prefixes included in this object listing. Common prefixes
	 * are only present if a delimiter was specified in the original request.
	 * 
	 * 
	 * Each common prefix represents a set of keys in the Nos bucket that have
	 * been condensed and omitted from the object summary results. This allows
	 * applications to organize and browse their keys hierarchically, similar to
	 * how a file system organizes files into directories.
	 * 
	 * 
	 * For example, consider a bucket that contains the following keys:
	 * 

	 * "foo/bar/baz"
	 * "foo/bar/bash"
	 * "foo/bar/bang"
	 * "foo/boo"
	 * 
	 * If calling listObjects with the prefix="foo/" and the
	 * delimiter="/" on this bucket, the returned NosObjectListing
	 * will contain one entry in the common prefixes list ("foo/bar/") and none
	 * of the keys beginning with that common prefix will be included in the
	 * object summaries list.
	 * 
	 * @return The list of common prefixes included in this object listing,
	 *         which might be an empty list if no common prefixes were found.
	 */
	public List getCommonPrefixes() {
		return commonPrefixes;
	}

	/**
	 * For internal use only. Sets the common prefixes for this object listing,
	 * representing the key prefixes that were rolled up because of the
	 * request's delimiter parameter.
	 * 
	 * @param commonPrefixes
	 *            The common prefixes for this object listing.
	 */
	public void setCommonPrefixes(List commonPrefixes) {
		this.commonPrefixes = commonPrefixes;
	}

	/**
	 * Gets the marker to use in the next listObjects request in
	 * order to see the next page of results. If an object listing is not
	 * truncated, this method will return null. For truncated
	 * requests, this value is equal to the greatest lexicographical value of
	 * the object keys and common prefixes included in this listing.
	 * 
	 * @return The marker to use in the next listObjects request in
	 *         order to see the next page of results if this object listing is
	 *         truncated. Returns null if this object listing isn't
	 *         truncated.
	 */
	public String getNextMarker() {
		return nextMarker;
	}

	/**
	 * For internal use only. Sets the marker to use in the next list objects
	 * request in order to see the next page of results for a truncated object
	 * listing.
	 * 
	 * @param nextMarker
	 *            The marker to use in the next listObjects request in order to
	 *            see the next page of results for a truncated object listing.
	 */
	public void setNextMarker(String nextMarker) {
		this.nextMarker = nextMarker;
	}

	/**
	 * Gets the name of the Nos bucket containing the objects listed in this
	 * {@link ObjectListing}.
	 * 
	 * @return The name of the Nos bucket containing the objects listed in this
	 *         {@link ObjectListing}.
	 */
	public String getBucketName() {
		return bucketName;
	}

	/**
	 * For internal use only. Sets the name of the Nos bucket containing the
	 * objects listed in this NosObjectListing.
	 * 
	 * @param bucketName
	 *            The name of the Nos bucket containing the objects listed in
	 *            this NosObjectListing.
	 */
	public void setBucketName(String bucketName) {
		this.bucketName = bucketName;
	}

	/**
	 * Gets the prefix parameter originally used to request this object listing,
	 * or null if no prefix was specified. All objects and common
	 * prefixes included in this object listing start with the specified prefix.
	 * 
	 * @return The prefix parameter originally used to request this object
	 *         listing. Returns null if no prefix was specified.
	 */
	public String getPrefix() {
		return prefix;
	}

	/**
	 * For internal use only. Sets the prefix parameter originally used to
	 * request this object listing.
	 * 
	 * @param prefix
	 *            The prefix parameter originally used to request this object
	 *            listing.
	 */
	public void setPrefix(String prefix) {
		this.prefix = prefix;
	}

	/**
	 * Gets the marker parameter originally used to request this object listing,
	 * or null if no marker was specified. If specified, all
	 * objects and common prefixes included in this object listing will occur
	 * alphabetically after the specified marker.
	 * 
	 * @return The marker parameter originally used to request this object
	 *         listing. Returns null if no marker was specified.
	 */
	public String getMarker() {
		return marker;
	}

	/**
	 * For internal use only. Sets the marker parameter originally used to
	 * request this object listing.
	 * 
	 * @param marker
	 *            The marker parameter originally used to request this object
	 *            listing.
	 */
	public void setMarker(String marker) {
		this.marker = marker;
	}

	/**
	 * Gets the maxKeys parameter originally used to request this
	 * object listing, or the default maxKeys value provided by Nos
	 * if the requester didn't specify a value. The maxKeys
	 * parameter limits the combined number of objects and common prefixes
	 * included in this object listing. An object listing will never contain
	 * more objects plus common prefixes than indicated by the
	 * maxKeys, but can of course contain less.
	 * 
	 * @return The maxKeysmaxKeys value
	 *         applied by Nos if no value was specified.
	 */
	public int getMaxKeys() {
		return maxKeys;
	}

	/**
	 * For internal use only. Sets the maxKeys parameter originally
	 * used to request this object listing, or the default maxKeys applied by
	 * Nos if the requester didn't specify a value.
	 * 
	 * @param maxKeys
	 *            The maxKeys parameter originally used to request
	 *            this object listing, or the default maxKeys value
	 *            applied by Nos if the requester didn't specify a value.
	 */
	public void setMaxKeys(int maxKeys) {
		this.maxKeys = maxKeys;
	}

	/**
	 * Gets the delimiter parameter originally used to request this object
	 * listing, or null if no delimiter specified.
	 * 
	 * The delimiter value allows callers to condense Nos keys into common
	 * prefix listings. For example, if a caller specifies a delimiter of "/" (a
	 * common used value for delimiter), any keys that contain a common prefix
	 * between the start of the key and the first occurrence of "/" will not be
	 * included in the list of object summaries. Instead, the common prefixes
	 * list will have one entry for the common prefix.
	 * 
	 * 
	 * @return The delimiter parameter originally used to request this object
	 *         listing. Returns null if no delimiter was specified.
	 */
	public String getDelimiter() {
		return delimiter;
	}

	/**
	 * For internal use only. Sets the delimiter parameter originally used to
	 * request this object listing.
	 * 
	 * @param delimiter
	 *            The delimiter parameter originally used to request this object
	 *            listing.
	 */
	public void setDelimiter(String delimiter) {
		this.delimiter = delimiter;
	}

	/**
	 * Gets whether or not this object listing is complete.
	 * 
	 * @return The value true if the object listing is not
	 *         complete. Returns the value false if otherwise.
	 *         When returning true, additional calls to Nos may be
	 *         needed in order to obtain more results.
	 */
	public boolean isTruncated() {
		return 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 Nos to get more object
	 * summaries.
	 * 
	 * @param isTruncated
	 *            The value true if the object listing is not
	 *            complete. The value false if otherwise.
	 */
	public void setTruncated(boolean isTruncated) {
		this.isTruncated = isTruncated;
	}

}