com.netease.cloud.services.nos.model.GetObjectMetadataRequest 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.WebServiceRequest;
import com.netease.cloud.services.nos.Nos;

/**
 * 
 * Provides options for obtaining the metadata for the specified object without
 * actually fetching the object contents. This is useful if obtaining only
 * object metadata, and avoids wasting bandwidth from retrieving the object
 * data.
 * 
 * 
 * The object metadata contains information such as content type, content
 * disposition, etc., as well as custom user metadata that can be associated
 * with an object in .
 * 
 * 
 * For more information about enabling versioning for a bucket, see
 * {@link Nos#setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest)}
 * .
 * 
 * 
 * @see GetObjectMetadataRequest#GetObjectMetadataRequest(String, String)
 * @see GetObjectMetadataRequest#GetObjectMetadataRequest(String, String,
 *      String)
 * @see GetObjectRequest
 */
public class GetObjectMetadataRequest extends WebServiceRequest {

	/**
	 * The name of the bucket containing the object's whose metadata is being
	 * retrieved.
	 */
	private String bucketName;

	/**
	 * The key of the object whose metadata is being retrieved.
	 */
	private String key;

	/**
	 * The optional version ID of the object version whose metadata is being
	 * retrieved. If not specified, the latest version will be used.
	 */
	private String versionId;

	/**
	 * Optional field that constrains this request to only be executed if the
	 * object has been modified since the specified date.
	 */
	private Date modifiedSinceConstraint;

	/**
	 * Constructs a new {@link GetObjectMetadataRequest} used to retrieve a
	 * specified object's metadata.
	 * 
	 * @param bucketName
	 *            The name of the bucket containing the object whose metadata is
	 *            being retrieved.
	 * @param key
	 *            The key of the object whose metadata is being retrieved.
	 * 
	 * @see GetObjectMetadataRequest#GetObjectMetadataRequest(String bucketName,
	 *      String key, String versionId)
	 */
	public GetObjectMetadataRequest(String bucketName, String key) {
		setBucketName(bucketName);
		setKey(key);
	}

	/**
	 * Constructs a new {@link GetObjectMetadataRequest} with basic options.
	 * 
	 * @param bucketName
	 *            The name of the bucket containing the object whose metadata is
	 *            being retrieved.
	 * @param key
	 *            The key of the object whose metadata is being retrieved.
	 * @param versionId
	 *            The version ID of the object version whose metadata is being
	 *            retrieved.
	 * 
	 * @see GetObjectMetadataRequest#GetObjectMetadataRequest(String bucketName,
	 *      String key)
	 */
	public GetObjectMetadataRequest(String bucketName, String key, String versionId) {
		this(bucketName, key);
		setVersionId(versionId);
	}

	/**
	 * Gets the name of the bucket containing the object whose metadata is being
	 * retrieved.
	 * 
	 * @return The name of the bucket containing the object whose metadata is
	 *         being retrieved.
	 * 
	 * @see GetObjectMetadataRequest#setBucketName(String bucketName)
	 * @see GetObjectMetadataRequest#withBucketName(String)
	 */
	public String getBucketName() {
		return bucketName;
	}

	/**
	 * Sets the name of the bucket containing the object whose metadata is being
	 * retrieved.
	 * 
	 * @param bucketName
	 *            The name of the bucket containing the object's whose metadata
	 *            is being retrieved.
	 * 
	 * @see GetObjectMetadataRequest#getBucketName()
	 * @see GetObjectMetadataRequest#withBucketName(String)
	 */
	public void setBucketName(String bucketName) {
		this.bucketName = bucketName;
	}

	/**
	 * Sets the name of the bucket containing the object whose metadata is being
	 * retrieved. Returns this {@link GetObjectMetadataRequest}, enabling
	 * additional method calls to be chained together.
	 * 
	 * @param bucketName
	 *            The name of the bucket containing the object's whose metadata
	 *            is being retrieved.
	 * 
	 * @return This {@link GetObjectMetadataRequest}, enabling additional method
	 *         calls to be chained together.
	 * 
	 * @see GetObjectMetadataRequest#getBucketName()
	 * @see GetObjectMetadataRequest#setBucketName(String bucketName)
	 */
	public GetObjectMetadataRequest withBucketName(String bucketName) {
		setBucketName(bucketName);
		return this;
	}

	/**
	 * Gets the key of the object whose metadata is being retrieved.
	 * 
	 * @return The key of the object whose metadata is being retrieved.
	 * 
	 * @see GetObjectMetadataRequest#setKey(String)
	 * @see GetObjectMetadataRequest#withKey(String)
	 */
	public String getKey() {
		return key;
	}

	/**
	 * Sets the key of the object whose metadata is being retrieved.
	 * 
	 * @param key
	 *            The key of the object whose metadata is being retrieved.
	 * 
	 * @see GetObjectMetadataRequest#getKey()
	 * @see GetObjectMetadataRequest#withKey(String)
	 */
	public void setKey(String key) {
		this.key = key;
	}

	/**
	 * Sets the key of the object whose metadata is being retrieved. Returns
	 * this {@link GetObjectMetadataRequest}, enabling additional method calls
	 * to be chained together.
	 * 
	 * @param key
	 *            The key of the object whose metadata is being retrieved.
	 * 
	 * @return This {@link GetObjectMetadataRequest}, enabling additional method
	 *         calls to be chained together.
	 * 
	 * @see GetObjectMetadataRequest#getKey()
	 * @see GetObjectMetadataRequest#setKey(String)
	 */
	public GetObjectMetadataRequest withKey(String key) {
		setKey(key);
		return this;
	}

	/**
	 * Gets the optional version ID of the object version whose metadata is
	 * being retrieved. If not specified, the latest version will be used.
	 * 
	 * @return The optional version ID of the object version whose metadata is
	 *         being retrieved. If not specified, the latest version will be
	 *         used.
	 * 
	 * @see GetObjectMetadataRequest#setVersionId(String)
	 * @see GetObjectMetadataRequest#withVersionId(String)
	 */
	public String getVersionId() {
		return versionId;
	}

	/**
	 * Sets the optional version ID of the object version whose metadata is
	 * being retrieved. If not specified, the latest version will be used.
	 * 
	 * @param versionId
	 *            The optional version ID of the object version whose metadata
	 *            is being retrieved. If not specified, the latest version will
	 *            be used.
	 * 
	 * @see GetObjectMetadataRequest#getVersionId()
	 * @see GetObjectMetadataRequest#withVersionId(String)
	 */
	public void setVersionId(String versionId) {
		this.versionId = versionId;
	}

	/**
	 * Gets the optional modified constraint that restricts this request to
	 * executing only if the object has been modified after the specified
	 * date.
	 * 
	 * @return The optional modified constraint that restricts this request to
	 *         executing only if the object has been modified after the
	 *         specified date.
	 * 
	 * @see GetObjectRequest#setModifiedSinceConstraint(Date)
	 * @see GetObjectRequest#withModifiedSinceConstraint(Date)
	 */
	public Date getModifiedSinceConstraint() {
		return modifiedSinceConstraint;
	}

	/**
	 * Sets the optional modified constraint that restricts this request to
	 * executing only if the object has been modified after the specified
	 * date.
	 * 
	 * Note that Nos will ignore any dates occurring in the future.
	 * 
	 * 
	 * @param date
	 *            The modified constraint that restricts this request to
	 *            executing only if the object has been modified after
	 *            the specified date.
	 * 
	 * @see GetObjectRequest#getModifiedSinceConstraint()
	 * @see GetObjectRequest#withModifiedSinceConstraint(Date)
	 */
	public void setModifiedSinceConstraint(Date date) {
		this.modifiedSinceConstraint = date;
	}

	/**
	 * Sets the optional version ID of the object version whose metadata is
	 * being retrieved. Returns this {@link GetObjectMetadataRequest}, enabling
	 * additional method calls to be chained together. If not specified, the
	 * latest version will be used.
	 * 
	 * @param versionId
	 *            The optional version ID of the object version whose metadata
	 *            is being retrieved.
	 * 
	 * @return This {@link GetObjectMetadataRequest}, enabling additional method
	 *         calls to be chained together.
	 * 
	 * @see GetObjectMetadataRequest#getVersionId()
	 * @see GetObjectMetadataRequest#setVersionId(String)
	 */
	public GetObjectMetadataRequest withVersionId(String versionId) {
		setVersionId(versionId);
		return this;
	}

}