ShareFileCreateOptions Class

  • Reference
Package:
com.azure.storage.file.share.options
Maven Artifact:
com.azure:azure-storage-file-share:12.24.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)

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()
ShareRequestConditions getRequestConditions()

Gets the ShareRequestConditions.
ShareFileHttpHeaders getShareFileHttpHeaders()
long getSize()
FileSmbProperties getSmbProperties()
ShareFileCreateOptions setFilePermission(String filePermissionKey)

Sets the file permission.
ShareFileCreateOptions setFilePermissionFormat(FilePermissionFormat filePermissionFormat)

Sets the file permission format.
ShareFileCreateOptions setMetadata(Map<String,String> metadata)
ShareFileCreateOptions setRequestConditions(ShareRequestConditions requestConditions)

Sets the ShareRequestConditions.
ShareFileCreateOptions setShareFileHttpHeaders(ShareFileHttpHeaders headers)

Sets the file's http headers.
ShareFileCreateOptions setSmbProperties(FileSmbProperties smbProperties)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ShareFileCreateOptions

public ShareFileCreateOptions(long size)

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()

Returns:

Metadata to associate with the share

getRequestConditions

public ShareRequestConditions getRequestConditions()

Gets the ShareRequestConditions.

Returns:

getShareFileHttpHeaders

public ShareFileHttpHeaders getShareFileHttpHeaders()

Returns:

the file's http headers.

getSize

public long getSize()

Returns:

Specifies the maximum size for the file share.

getSmbProperties

public FileSmbProperties getSmbProperties()

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)

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.

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)

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.

Applies to