ShareFileCreateOptions Class

Package:

com.azure.storage.file.share.options

Maven Artifact:

com.azure:azure-storage-file-share:12.26.0

• java.lang.Object
• • com.azure.storage.file.share.options.ShareFileCreateOptions

public class ShareFileCreateOptions

Extended options that may be passed when creating a share.

Constructor Summary

Constructor	Description
ShareFileCreateOptions(long size)	Creates a new instance of ShareFileCreateOptions.

Method Summary

Modifier and Type	Method and Description
String	getFilePermission() Gets the file permission.
FilePermissionFormat	getFilePermissionFormat() Gets the file permission format.
Map<String,String>	getMetadata() Gets the metadata to associate with the share.
FilePosixProperties	getPosixProperties() Optional properties to set on NFS files.
ShareRequestConditions	getRequestConditions() Gets the ShareRequestConditions.
ShareFileHttpHeaders	getShareFileHttpHeaders() Gets the file's http headers.
long	getSize() Gets the maximum size for the file share.
FileSmbProperties	getSmbProperties() Gets the optional SMB properties to set on the destination file or directory.
ShareFileCreateOptions	setFilePermission(String filePermissionKey) Sets the file permission.
ShareFileCreateOptions	setFilePermissionFormat(FilePermissionFormat filePermissionFormat) Sets the file permission format.
ShareFileCreateOptions	setMetadata(Map<String,String> metadata) Sets the metadata to associate with the share.
ShareFileCreateOptions	setPosixProperties(FilePosixProperties posixProperties) Optional properties to set on NFS files.
ShareFileCreateOptions	setRequestConditions(ShareRequestConditions requestConditions) Sets the ShareRequestConditions.
ShareFileCreateOptions	setShareFileHttpHeaders(ShareFileHttpHeaders headers) Sets the file's http headers.
ShareFileCreateOptions	setSmbProperties(FileSmbProperties smbProperties) Sets the optional SMB properties to set on the destination file or directory.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ShareFileCreateOptions

public ShareFileCreateOptions(long size)

Creates a new instance of ShareFileCreateOptions.

Parameters:

size - Specifies the maximum size for the file share.

Method Details

getFilePermission

public String getFilePermission()

Gets the file permission.

Returns:

file permission.

getFilePermissionFormat

public FilePermissionFormat getFilePermissionFormat()

Gets the file permission format.

Returns:

file permission format.

getMetadata

public Map getMetadata()

Gets the metadata to associate with the share.

Returns:

Metadata to associate with the share

getPosixProperties

public FilePosixProperties getPosixProperties()

Optional properties to set on NFS files. Note that this property is only applicable to files created in NFS shares.

Returns:

FilePosixProperties

getRequestConditions

public ShareRequestConditions getRequestConditions()

Gets the ShareRequestConditions.

Returns:

ShareRequestConditions

getShareFileHttpHeaders

public ShareFileHttpHeaders getShareFileHttpHeaders()

Gets the file's http headers.

Returns:

the file's http headers.

getSize

public long getSize()

Gets the maximum size for the file share.

Returns:

Specifies the maximum size for the file share.

getSmbProperties

public FileSmbProperties getSmbProperties()

Gets the optional SMB properties to set on the destination file or directory.

Returns:

Optional SMB properties to set on the destination file or directory. The only properties that are considered are file attributes, file creation time, file last write time, and file permission key. The rest are ignored.

setFilePermission

public ShareFileCreateOptions setFilePermission(String filePermissionKey)

Sets the file permission.

Parameters:

filePermissionKey - the file permission.

Returns:

The updated options.

setFilePermissionFormat

public ShareFileCreateOptions setFilePermissionFormat(FilePermissionFormat filePermissionFormat)

Sets the file permission format.

Parameters:

filePermissionFormat - the file permission format.

Returns:

The updated options.

setMetadata

public ShareFileCreateOptions setMetadata(Map metadata)

Sets the metadata to associate with the share.

Parameters:

metadata - Metadata to associate with the share. If there is leading or trailing whitespace in any metadata key or value, it must be removed or encoded.

Returns:

The updated options.

setPosixProperties

public ShareFileCreateOptions setPosixProperties(FilePosixProperties posixProperties)

Optional properties to set on NFS files. Note that this property is only applicable to files created in NFS shares.

Parameters:

posixProperties - FilePosixProperties

Returns:

The updated options.

setRequestConditions

public ShareFileCreateOptions setRequestConditions(ShareRequestConditions requestConditions)

Sets the ShareRequestConditions.

Parameters:

requestConditions - ShareRequestConditions

Returns:

The updated options.

setShareFileHttpHeaders

public ShareFileCreateOptions setShareFileHttpHeaders(ShareFileHttpHeaders headers)

Sets the file's http headers.

Parameters:

headers - the http headers.

Returns:

the updated options.

setSmbProperties

public ShareFileCreateOptions setSmbProperties(FileSmbProperties smbProperties)

Sets the optional SMB properties to set on the destination file or directory.

Parameters:

smbProperties - Optional SMB properties to set on the destination file or directory. The only properties that are considered are file attributes, file creation time, file last write time, and file permission key. The rest are ignored.

Returns:

The updated options.