com.microsoft.azure.storage.blob

Class BlobProperties

java.lang.Object

com.microsoft.azure.storage.blob.BlobProperties

public final class BlobProperties
extends Object

Represents the system properties for a blob.

Constructor Summary

Constructors

Constructor and Description
BlobProperties() Creates an instance of the BlobProperties class.
BlobProperties(BlobProperties other) Creates an instance of the BlobProperties class by copying values from another instance of the BlobProperties class.
BlobProperties(BlobType type) Creates an instance of the BlobProperties class.

Method Summary

Methods

Modifier and Type	Method and Description
Integer	getAppendBlobCommittedBlockCount() If the blob is an append blob, gets the number of committed blocks.
BlobType	getBlobType() Gets the blob type for the blob.
String	getCacheControl() Gets the cache control value for the blob.
String	getContentDisposition() Gets the content disposition value for the blob.
String	getContentEncoding() Gets the content encoding value for the blob.
String	getContentLanguage() Gets the content language value for the blob.
String	getContentMD5() Gets the content MD5 value for the blob.
String	getContentType() Gets the content type value for the blob.
CopyState	getCopyState() Gets the blob's copy state.
Date	getCreatedTime() Gets the time when the blob was created.
Date	getDeletedTime() Gets the time when the blob was deleted.
String	getEtag() Gets the ETag value for the blob.
Date	getLastModified() Gets the last modified time for the blob.
LeaseDuration	getLeaseDuration() Gets the lease duration for the blob.
LeaseState	getLeaseState() Gets the lease state for the blob.
LeaseStatus	getLeaseStatus() Gets the lease status for the blob.
long	getLength() Gets the size, in bytes, of the blob.
Long	getPageBlobSequenceNumber() If the blob is a page blob, gets the page blob's current sequence number.
PremiumPageBlobTier	getPremiumPageBlobTier() If using a premium account and the blob is a page blob, gets the tier of the blob.
RehydrationStatus	getRehydrationStatus() The rehydration status if the blob is being rehydrated and the tier of the blob once the rehydration from archive has completed.
Integer	getRemainingRetentionDays() Gets the number of days that the deleted blob will be kept by the service.
StandardBlobTier	getStandardBlobTier() If using a standard account and the blob is a block blob, gets the tier of the blob.
Date	getTierChangeTime() Gets a value indicating the last time the tier was changed on the blob.
Boolean	isBlobTierInferred() Gets a value indicating if the tier of the blob has been inferred.
boolean	isIncrementalCopy() Gets if the blob is an incremental copy
boolean	isServerEncrypted() Gets the blob's server-side encryption status;
void	setCacheControl(String cacheControl) Sets the cache control value for the blob.
void	setContentDisposition(String contentDisposition) Sets the content disposition value for the blob.
void	setContentEncoding(String contentEncoding) Sets the content encoding value for the blob.
void	setContentLanguage(String contentLanguage) Sets the content language for the blob.
void	setContentMD5(String contentMD5) Sets the content MD5 value for the blob.
void	setContentType(String contentType) Sets the content type value for the blob.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlobProperties

public BlobProperties()

Creates an instance of the BlobProperties class.

BlobProperties

public BlobProperties(BlobProperties other)

Creates an instance of the BlobProperties class by copying values from another instance of the BlobProperties class.

Parameters:

other - A BlobProperties object which represents the blob properties to copy.

BlobProperties

public BlobProperties(BlobType type)

Creates an instance of the BlobProperties class.

Parameters:

type - A BlobType object which represents the blob type.

Method Detail

getAppendBlobCommittedBlockCount

public Integer getAppendBlobCommittedBlockCount()

If the blob is an append blob, gets the number of committed blocks.

Returns:

A Integer value that represents the number of committed blocks.

getBlobType

public BlobType getBlobType()

Gets the blob type for the blob.

Returns:

A BlobType value that represents the blob type.

getCacheControl

public String getCacheControl()

Gets the cache control value for the blob.

Returns:

A String which represents the content cache control value for the blob.

getContentDisposition

public String getContentDisposition()

Gets the content disposition value for the blob.

Returns:

A String which represents the content disposition, or null if content disposition has not been set on the blob.

getContentEncoding

public String getContentEncoding()

Gets the content encoding value for the blob.

Returns:

A String which represents the content encoding, or null if content encoding has not been set on the blob.

getContentLanguage

public String getContentLanguage()

Gets the content language value for the blob.

Returns:

A String which represents the content language, or null if content language has not been set on the blob.

getContentMD5

public String getContentMD5()

Gets the content MD5 value for the blob.

Returns:

A String which represents the content MD5 value.

getContentType

public String getContentType()

Gets the content type value for the blob.

Returns:

A String which represents the content type, or null if the content type has not be set for the blob.

getCopyState

public CopyState getCopyState()

Gets the blob's copy state.

Returns:

A CopyState object which represents the copy state of the blob.

getCreatedTime

public Date getCreatedTime()

Gets the time when the blob was created.

Returns:

A Date object which represents the time when the blob was created.

getEtag

public String getEtag()

Gets the ETag value for the blob.

The ETag value is a unique identifier that is updated when a write operation is performed against the container. It may be used to perform operations conditionally, providing concurrency control and improved efficiency.

The AccessCondition.generateIfMatchCondition(String) and AccessCondition.generateIfNoneMatchCondition(String) methods take an ETag value and return an AccessCondition object that may be specified on the request.

Returns:

A String which represents the ETag value.

getLastModified

public Date getLastModified()

Gets the last modified time for the blob.

Returns:

A Date object which represents the last modified time.

isBlobTierInferred

public Boolean isBlobTierInferred()

Gets a value indicating if the tier of the blob has been inferred.

Returns:

A Boolean object which represents if the blob tier was inferred.

getTierChangeTime

public Date getTierChangeTime()

Gets a value indicating the last time the tier was changed on the blob.

Returns:

A Date object which represents the last time the tier was changed.

getLeaseStatus

public LeaseStatus getLeaseStatus()

Gets the lease status for the blob.

Returns:

A LeaseStatus object which represents the lease status.

getLeaseState

public LeaseState getLeaseState()

Gets the lease state for the blob.

Returns:

A LeaseState object which represents the lease state.

getLeaseDuration

public LeaseDuration getLeaseDuration()

Gets the lease duration for the blob.

Returns:

A LeaseDuration object which represents the lease duration.

getLength

public long getLength()

Gets the size, in bytes, of the blob.

Returns:

A long which represents the length of the blob.

getPageBlobSequenceNumber

public Long getPageBlobSequenceNumber()

If the blob is a page blob, gets the page blob's current sequence number.

Returns:

A Long containing the page blob's current sequence number.

getPremiumPageBlobTier

public PremiumPageBlobTier getPremiumPageBlobTier()

If using a premium account and the blob is a page blob, gets the tier of the blob.

Returns:

A PremiumPageBlobTier object which represents the tier of the blob or null if the tier has not been set.

getStandardBlobTier

public StandardBlobTier getStandardBlobTier()

If using a standard account and the blob is a block blob, gets the tier of the blob.

Returns:

A StandardBlobTier object which represents the tier of the blob or null if the tier has not been set.

getRehydrationStatus

public RehydrationStatus getRehydrationStatus()

The rehydration status if the blob is being rehydrated and the tier of the blob once the rehydration from archive has completed.

Returns:

isServerEncrypted

public boolean isServerEncrypted()

Gets the blob's server-side encryption status;

Returns:

A boolean which specifies the blob's encryption status.

isIncrementalCopy

public boolean isIncrementalCopy()

Gets if the blob is an incremental copy

Returns:

A boolean which specifies if the blob is an incremental copy.

getDeletedTime

public Date getDeletedTime()

Gets the time when the blob was deleted.

Returns:

A Date object which represents the time when the blob was deleted. It returns null if the blob has not been deleted.

getRemainingRetentionDays

public Integer getRemainingRetentionDays()

Gets the number of days that the deleted blob will be kept by the service.

Returns:

A Integer value that represents the number of days that the deleted blob will be kept by the service.

setCacheControl

public void setCacheControl(String cacheControl)

Sets the cache control value for the blob.

Parameters:

cacheControl - A String which specifies the cache control value to set.

setContentDisposition

public void setContentDisposition(String contentDisposition)

Sets the content disposition value for the blob.

Parameters:

contentDisposition - A String which specifies the content disposition value to set.

setContentEncoding

public void setContentEncoding(String contentEncoding)

Sets the content encoding value for the blob.

Parameters:

contentEncoding - A String which specifies the content encoding value to set.

setContentLanguage

public void setContentLanguage(String contentLanguage)

Sets the content language for the blob.

Parameters:

contentLanguage - A String which specifies the content language value to set.

setContentMD5

public void setContentMD5(String contentMD5)

Sets the content MD5 value for the blob.

Parameters:

contentMD5 - A String which specifies the content MD5 value to set.

setContentType

public void setContentType(String contentType)

Sets the content type value for the blob.

Parameters:

contentType - A String which specifies the content type value to set.