BlobContainerProperties Class

Package:

com.microsoft.azure.storage.blob

• java.lang.Object
• • com.microsoft.azure.storage.blob.BlobContainerProperties

public class BlobContainerProperties

Represents the system properties for a container.

Method Summary

Modifier and Type	Method and Description
String	getEtag() Gets the ETag value of the container. 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 generateIfMatchCondition(final String etag) and generateIfNoneMatchCondition(final String etag) methods take an ETag value and return an AccessCondition object that may be specified on the request.
Date	getLastModified() Gets the last modified time on the container.
LeaseDuration	getLeaseDuration() Gets the lease duration of the container.
LeaseState	getLeaseState() Gets the lease state of the container.
LeaseStatus	getLeaseStatus() Gets the lease status of the container.
BlobContainerPublicAccessType	getPublicAccess() Gets the public access level for the container. This field should only be set using the container's BlobRequestOptions, com.microsoft.azure.storage.OperationContext) create method or uploadPermissions(final BlobContainerPermissions permissions) method.
Boolean	hasImmutabilityPolicy() Gets the hasImmutabilityPolicy value of the container.
Boolean	hasLegalHold() Gets the hasLegalHold value of the container.
void	setEtag(final String etag) Sets the ETag value on the container.
void	setHasImmutabilityPolicy(final Boolean hasImmutabilityPolicy) Sets the hasImmutabilityPolicy value on the container.
void	setHasLegalHold(final Boolean hasLegalHold) Sets the hasLegalHold value on the container.
void	setLastModified(final Date lastModified) Sets the last modified time on the container.
void	setLeaseDuration(final LeaseDuration leaseDuration) Sets the lease duration on the container.
void	setLeaseState(final LeaseState leaseState) Sets the lease status on the container.
void	setLeaseStatus(final LeaseStatus leaseStatus) Sets the lease status on the container.
void	setPublicAccess(final BlobContainerPublicAccessType publicAccess) Sets the public access level on the container. This should only be set using the container's BlobRequestOptions, com.microsoft.azure.storage.OperationContext) create method or uploadPermissions(final BlobContainerPermissions permissions) method.

Method Details

getEtag

public String getEtag()

Gets the ETag value of the container.

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 generateIfMatchCondition(final String etag) and generateIfNoneMatchCondition(final String etag) methods take an ETag value and return an AccessCondition object that may be specified on the request.

Returns:

A String which represents the ETag.

getLastModified

public Date getLastModified()

Gets the last modified time on the container.

Returns:

A java.util.Date object which represents the last modified time.

getLeaseDuration

public LeaseDuration getLeaseDuration()

Gets the lease duration of the container.

Returns:

A LeaseDuration object which represents the lease duration of the container.

getLeaseState

public LeaseState getLeaseState()

Gets the lease state of the container.

Returns:

A LeaseState object which represents the lease state of the container.

getLeaseStatus

public LeaseStatus getLeaseStatus()

Gets the lease status of the container.

Returns:

A LeaseStatus object which represents the lease status of the container.

getPublicAccess

public BlobContainerPublicAccessType getPublicAccess()

Gets the public access level for the container. This field should only be set using the container's BlobRequestOptions, com.microsoft.azure.storage.OperationContext) create method or uploadPermissions(final BlobContainerPermissions permissions) method.

Returns:

A BlobContainerPublicAccessType that specifies the level of public access that is allowed on the container.

hasImmutabilityPolicy

public Boolean hasImmutabilityPolicy()

Gets the hasImmutabilityPolicy value of the container.

Returns:

A Boolean which represents the hasImmutabilityPolicy value.

hasLegalHold

public Boolean hasLegalHold()

Gets the hasLegalHold value of the container.

Returns:

A Boolean which represents the hasLegalHold value.

setEtag

protected void setEtag(final String etag)

Sets the ETag value on the container.

Parameters:

etag - A String which represents the ETag to set.

setHasImmutabilityPolicy

protected void setHasImmutabilityPolicy(final Boolean hasImmutabilityPolicy)

Sets the hasImmutabilityPolicy value on the container.

Parameters:

hasImmutabilityPolicy - A Boolean which represents the hasImmutabilityProperty value to set.

setHasLegalHold

protected void setHasLegalHold(final Boolean hasLegalHold)

Sets the hasLegalHold value on the container.

Parameters:

hasLegalHold - A Boolean which represents the hasLegalHold value to set.

setLastModified

protected void setLastModified(final Date lastModified)

Sets the last modified time on the container.

Parameters:

lastModified - A java.util.Date object which represents the last modified time to set.

setLeaseDuration

protected void setLeaseDuration(final LeaseDuration leaseDuration)

Sets the lease duration on the container.

Parameters:

leaseDuration - A LeaseDuration object which represents the lease duration of the container.

setLeaseState

protected void setLeaseState(final LeaseState leaseState)

Sets the lease status on the container.

Parameters:

leaseState - A LeaseState object which represents the lease state of the container.

setLeaseStatus

protected void setLeaseStatus(final LeaseStatus leaseStatus)

Sets the lease status on the container.

Parameters:

leaseStatus - A LeaseStatus object which represents the lease status of the container.

setPublicAccess

protected void setPublicAccess(final BlobContainerPublicAccessType publicAccess)

Sets the public access level on the container. This should only be set using the container's BlobRequestOptions, com.microsoft.azure.storage.OperationContext) create method or uploadPermissions(final BlobContainerPermissions permissions) method.

Parameters:

publicAccess - A BlobContainerPublicAccessType object which represents the public access level on the container.