com.netease.cloud.services.nos.model.NOSVersionSummary 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.Date;

import com.netease.cloud.services.nos.internal.Constants;

/**
 * Contains the summary of a version stored in an Nos bucket. This object
 * doesn't contain the version's full metadata or any of its contents.
 * 
 * @see NOSObject
 * @see NOSObjectSummary
 */
public class NOSVersionSummary {

	/** The name of the bucket in which this version is stored */
	protected String bucketName;

	/** The key under which this version is stored */
	private String key;

	/** The version ID uniquely identifying this version of an object */
	private String versionId;

	/** True if this is the latest version of the associated object */
	private boolean isLatest;

	/** The date, according to Nos, when this version was last modified */
	private Date lastModified;

	/**
	 * The owner of this version of the associated object - can be null if the
	 * requester doesn't have permission to view object ownership information
	 */
	private Owner owner;

	/** Hex encoded MD5 hash of this version's contents, as computed by Nos */
	private String eTag;

	/** The size of this version, in bytes */
	private long size;

	/** The class of storage used by Nos to store this version */
	private String storageClass;

	/** True if this object represents a delete marker */
	private boolean isDeleteMarker;

	/**
	 * Gets the name of the Nos bucket in which this version is stored.
	 * 
	 * @return The name of the Nos bucket in which this version is stored.
	 * 
	 * @see NOSVersionSummary#setBucketName(String)
	 */
	public String getBucketName() {
		return bucketName;
	}

	/**
	 * Sets the name of the Nos bucket in which this version is stored.
	 * 
	 * @param bucketName
	 *            The name of the Nos bucket in which this version is stored.
	 * 
	 * @see NOSVersionSummary#getBucketName()
	 */
	public void setBucketName(String bucketName) {
		this.bucketName = bucketName;
	}

	/**
	 * Gets the key under which this version is stored in Nos.
	 * 
	 * @return The key under which this version is stored in Nos.
	 * 
	 * @see NOSVersionSummary#setKey(String)
	 */
	public String getKey() {
		return key;
	}

	/**
	 * Sets the key under which this version is stored in Nos.
	 * 
	 * @param key
	 *            The key under which this version is stored in Nos.
	 * 
	 * @see NOSVersionSummary#getKey()
	 */
	public void setKey(String key) {
		this.key = key;
	}

	/**
	 * Gets the version ID which uniquely identifies this version of an object.
	 * 
	 * Objects created before versioning was enabled or when versioning is
	 * suspended will be given the default/null version ID (see
	 * {@link Constants#NULL_VERSION_ID}). Note that the
	 * {@link Constants#NULL_VERSION_ID} is a valid version ID and is not the
	 * same as not having a version ID.
	 * 
	 * 
	 * @return The version ID which uniquely identifies this version of an
	 *         object.
	 * 
	 * @see NOSVersionSummary#setVersionId(String)
	 */
	public String getVersionId() {
		return versionId;
	}

	/**
	 * Sets the version ID which uniquely identifies this version of an object.
	 * 
	 * @param id
	 *            The version ID which uniquely identifies this version of an
	 *            object.
	 * 
	 * @see NOSVersionSummary#getVersionId()
	 */
	public void setVersionId(String id) {
		this.versionId = id;
	}

	/**
	 * Returns whether or not this version is the latest version for the
	 * associated object.
	 * 
	 * @return The value true if this version is the latest version
	 *         for the associated object; returns the value false
	 *         if otherwise.
	 */
	public boolean isLatest() {
		return this.isLatest;
	}

	/**
	 * For internal use only. Sets whether this version is the latest version
	 * for the associated object. This method is intended to be used only by the
	 * client internals and developers shouldn't need to use it.
	 * 
	 * @param isLatest
	 *            True if this version represents the latest version for the
	 *            associated object in Nos.
	 */
	public void setIsLatest(boolean isLatest) {
		this.isLatest = isLatest;
	}

	/**
	 * Gets the date according to Nos at which this version was last modified.
	 * 
	 * @return The date according to Nos at which this version was last
	 *         modified.
	 * 
	 * @see NOSVersionSummary#setLastModified(Date)
	 */
	public Date getLastModified() {
		return lastModified;
	}

	/**
	 * Sets the date according to Nos at which this version was last modified.
	 * 
	 * @param lastModified
	 *            The date according to Nos at which this version was last
	 *            modified.
	 * 
	 * @see NOSVersionSummary#getLastModified()
	 */
	public void setLastModified(Date lastModified) {
		this.lastModified = lastModified;
	}

	/**
	 * Gets the owner of this version.
	 * 
	 * @return The owner of this version. Returns null if the
	 *         requester doesn't have permission to see object ownership for
	 *         this version.
	 * 
	 * @see NOSVersionSummary#setOwner(Owner)
	 */
	public Owner getOwner() {
		return owner;
	}

	/**
	 * For internal use only. Sets the owner of this version. This method is
	 * intended to be used only by the client internals and developers shouldn't
	 * need to use it.
	 * 
	 * @param owner
	 *            The owner of this version.
	 * 
	 * @see NOSVersionSummary#getOwner()
	 */
	public void setOwner(Owner owner) {
		this.owner = owner;
	}

	/**
	 * Returns whether or not this version represents a delete marker.
	 * 
	 * Delete markers are special types of versions that have no data associated
	 * with them. When deleting a versioned object in Nos without specifying an
	 * explicit version ID, a new delete marker is created as the latest version
	 * of that object to mark that the object was deleted. This occurs even
	 * though the previous versions still exist in Nos.
	 * 
	 * 
	 * Delete markers have no data associated with them and therefore have no
	 * associated ACL, size or storage class. Only requesters with read access
	 * to a bucket can learn of their existence by listing the versions in a
	 * bucket.
	 * 
	 * 
	 * @return The value true if this version represents a delete
	 *         marker. Returns the value false if otherwise.
	 */
	public boolean isDeleteMarker() {
		return isDeleteMarker;
	}

	/**
	 * Intended for internal use only in the Nos client code. Sets the value of
	 * the isDeleteMarker property to record if this is a delete
	 * marker or not.
	 * 
	 * @param isDeleteMarker
	 *            Specify
	 *            true if this version summary represents a delete marker,
	 *            otherwise false if it is a regular version summary.
	 */
	public void setIsDeleteMarker(boolean isDeleteMarker) {
		this.isDeleteMarker = isDeleteMarker;
	}

	/**
	 * Gets the hex encoded 128-bit MD5 hash of this version's contents as
	 * computed by Nos.
	 * 
	 * @return The hex encoded 128-bit MD5 hash of this version's contents as
	 *         computed by Nos.
	 * 
	 * @see NOSVersionSummary#setETag(String)
	 */
	public String getETag() {
		return eTag;
	}

	/**
	 * Sets the hex encoded 128-bit MD5 hash of this version's contents as
	 * computed by Nos.
	 * 
	 * @param eTag
	 *            The hex encoded 128-bit MD5 hash of this version's contents as
	 *            computed by Nos.
	 * 
	 * @see NOSVersionSummary#getETag()
	 */
	public void setETag(String eTag) {
		this.eTag = eTag;
	}

	/**
	 * Gets the storage class used by Nos for this version.
	 * 
	 * @return The storage class used by Nos for this version.
	 * 
	 * @see NOSVersionSummary#setStorageClass(String)
	 */
	public String getStorageClass() {
		return storageClass;
	}

	/**
	 * Sets the storage class used by Nos for this version.
	 * 
	 * @param storageClass
	 *            The storage class used by Nos for this version.
	 * 
	 * @see NOSVersionSummary#getStorageClass()
	 */
	public void setStorageClass(String storageClass) {
		this.storageClass = storageClass;
	}

	/**
	 * Gets the size of this version in bytes.
	 * 
	 * @return The size of this version in bytes.
	 * 
	 * @see NOSVersionSummary#setSize(long)
	 */
	public long getSize() {
		return size;
	}

	/**
	 * Sets the size of this version in bytes.
	 * 
	 * @param size
	 *            The size of this version in bytes.
	 * 
	 * @see NOSVersionSummary#getSize()
	 */
	public void setSize(long size) {
		this.size = size;
	}

}