public class

S3VersionSummary

extends Object
implements Serializable
java.lang.Object
   ↳ org.mule.module.s3.model.S3VersionSummary

Class Overview

Contains the summary of a version stored in an Amazon S3 bucket. This object doesn't contain the version's full metadata or any of its contents.

See Also

Summary

Constants
long serialVersionUID
Fields
protected String bucketName The name of the bucket in which this version is stored
private String eTag Hex encoded MD5 hash of this version's contents, as computed by Amazon S3
private boolean isDeleteMarker True if this object represents a delete marker
private boolean isLatest True if this is the latest version of the associated object
private String key The key under which this version is stored
private Date lastModified The date, according to Amazon S3, when this version was last modified
private Owner owner 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 long size The size of this version, in bytes
private String storageClass The class of storage used by Amazon S3 to store this version
private String versionId The version ID uniquely identifying this version of an object
Public Constructors
S3VersionSummary()
Public Methods
String getBucketName()
Gets the name of the Amazon S3 bucket in which this version is stored.
String getETag()
Gets the hex encoded 128-bit MD5 hash of this version's contents as computed by Amazon S3.
String getKey()
Gets the key under which this version is stored in Amazon S3.
Date getLastModified()
Gets the date according to Amazon S3 at which this version was last modified.
Owner getOwner()
Gets the owner of this version.
long getSize()
Gets the size of this version in bytes.
String getStorageClass()
Gets the storage class used by Amazon S3 for this version.
String getVersionId()
Gets the version ID which uniquely identifies this version of an object.
boolean isDeleteMarker()
Returns whether or not this version represents a delete marker.
boolean isLatest()
Returns whether or not this version is the latest version for the associated object.
void setBucketName(String bucketName)
Sets the name of the Amazon S3 bucket in which this version is stored.
void setETag(String eTag)
Sets the hex encoded 128-bit MD5 hash of this version's contents as computed by Amazon S3.
void setIsDeleteMarker(boolean isDeleteMarker)
Intended for internal use only in the Amazon S3 client code.
void setIsLatest(boolean isLatest)
For internal use only.
void setKey(String key)
Sets the key under which this version is stored in Amazon S3.
void setLastModified(Date lastModified)
Sets the date according to Amazon S3 at which this version was last modified.
void setOwner(Owner owner)
For internal use only.
void setSize(long size)
Sets the size of this version in bytes.
void setStorageClass(String storageClass)
Sets the storage class used by Amazon S3 for this version.
void setVersionId(String id)
Sets the version ID which uniquely identifies this version of an object.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

private static final long serialVersionUID

Constant Value: 8856424831071706519 (0x7ae85775e3fa5d97)

Fields

protected String bucketName

The name of the bucket in which this version is stored

private String eTag

Hex encoded MD5 hash of this version's contents, as computed by Amazon S3

private boolean isDeleteMarker

True if this object represents a delete marker

private boolean isLatest

True if this is the latest version of the associated object

private String key

The key under which this version is stored

private Date lastModified

The date, according to Amazon S3, when this version was last modified

private Owner owner

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 long size

The size of this version, in bytes

private String storageClass

The class of storage used by Amazon S3 to store this version

private String versionId

The version ID uniquely identifying this version of an object

Public Constructors

public S3VersionSummary ()

Public Methods

public String getBucketName ()

Gets the name of the Amazon S3 bucket in which this version is stored.

Returns
  • The name of the Amazon S3 bucket in which this version is stored.
See Also

public String getETag ()

Gets the hex encoded 128-bit MD5 hash of this version's contents as computed by Amazon S3.

Returns
  • The hex encoded 128-bit MD5 hash of this version's contents as computed by Amazon S3.
See Also

public String getKey ()

Gets the key under which this version is stored in Amazon S3.

Returns
  • The key under which this version is stored in Amazon S3.
See Also

public Date getLastModified ()

Gets the date according to Amazon S3 at which this version was last modified.

Returns
  • The date according to Amazon S3 at which this version was last modified.
See Also

public Owner getOwner ()

Gets the owner of this version. Returns null if the requester doesn't have Permission#ReadAcp permission for this version or owns the bucket in which it resides.

Returns
  • The owner of this version. Returns null if the requester doesn't have permission to see object ownership for this version.
See Also

public long getSize ()

Gets the size of this version in bytes.

Returns
  • The size of this version in bytes.
See Also

public String getStorageClass ()

Gets the storage class used by Amazon S3 for this version.

Returns
  • The storage class used by Amazon S3 for this version.
See Also

public String getVersionId ()

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.

Returns
  • The version ID which uniquely identifies this version of an object.
See Also

public boolean isDeleteMarker ()

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 Amazon S3 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 Amazon S3.

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.

Returns
  • The value true if this version represents a delete marker. Returns the value false if otherwise.

public boolean isLatest ()

Returns whether or not this version is the latest version for the associated object.

Returns
  • The value true if this version is the latest version for the associated object; returns the value false if otherwise.

public void setBucketName (String bucketName)

Sets the name of the Amazon S3 bucket in which this version is stored.

Parameters
bucketName The name of the Amazon S3 bucket in which this version is stored.
See Also

public void setETag (String eTag)

Sets the hex encoded 128-bit MD5 hash of this version's contents as computed by Amazon S3.

Parameters
eTag The hex encoded 128-bit MD5 hash of this version's contents as computed by Amazon S3.
See Also

public void setIsDeleteMarker (boolean isDeleteMarker)

Intended for internal use only in the Amazon S3 client code. Sets the value of the isDeleteMarker property to record if this is a delete marker or not.

Parameters
isDeleteMarker Specify true if this version summary represents a delete marker, otherwise false if it is a regular version summary.

public void setIsLatest (boolean 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.

Parameters
isLatest True if this version represents the latest version for the associated object in S3.

public void setKey (String key)

Sets the key under which this version is stored in Amazon S3.

Parameters
key The key under which this version is stored in Amazon S3.
See Also

public void setLastModified (Date lastModified)

Sets the date according to Amazon S3 at which this version was last modified.

Parameters
lastModified The date according to Amazon S3 at which this version was last modified.
See Also

public void setOwner (Owner 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.

Parameters
owner The owner of this version.
See Also

public void setSize (long size)

Sets the size of this version in bytes.

Parameters
size The size of this version in bytes.
See Also

public void setStorageClass (String storageClass)

Sets the storage class used by Amazon S3 for this version.

Parameters
storageClass The storage class used by Amazon S3 for this version.
See Also

public void setVersionId (String id)

Sets the version ID which uniquely identifies this version of an object.

Parameters
id The version ID which uniquely identifies this version of an object.
See Also