FileShareProperties Class

  • Reference
Package:
com.microsoft.azure.storage.file
  • java.lang.Object
    • com.microsoft.azure.storage.file.FileShareProperties

public class FileShareProperties

Represents the system properties for a share.

Constructor Summary

Constructor Description
FileShareProperties()

Creates an instance of the class.

FileShareProperties(final FileShareProperties other)

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

Method Summary

Modifier and Type Method and Description
String getEtag()

Gets the ETag value of the share.

The ETag value is a unique identifier that is updated when a write operation is performed against the share. 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 share.
Integer getShareQuota()

Gets the limit on the size of files (in GB) stored on the share.
void setEtag(final String etag)

Sets the ETag value on the share.
void setLastModified(final Date lastModified)

Sets the last modified time on the share.
void setShareQuota(Integer shareQuota)

Sets the limit on the size of files (in GB) stored on the share.

Constructor Details

FileShareProperties

public FileShareProperties()

Creates an instance of the class.

FileShareProperties

public FileShareProperties(final FileShareProperties other)

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

Parameters:

other - A FileShareProperties object which represents the file share properties to copy.

Method Details

getEtag

public String getEtag()

Gets the ETag value of the share.

The ETag value is a unique identifier that is updated when a write operation is performed against the share. 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 share.

Returns:

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

getShareQuota

public Integer getShareQuota()

Gets the limit on the size of files (in GB) stored on the share.

Returns:

A java.lang.Integer object which represents the limit on the size of files stored on the share.

setEtag

protected void setEtag(final String etag)

Sets the ETag value on the share.

Parameters:

etag - A String which represents the ETag to set.

setLastModified

protected void setLastModified(final Date lastModified)

Sets the last modified time on the share.

Parameters:

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

setShareQuota

public void setShareQuota(Integer shareQuota)

Sets the limit on the size of files (in GB) stored on the share.

Parameters:

shareQuota - A java.lang.Integer object which represents the limit on the size of files stored on the share.

Applies to