Package com.azure.storage.file.share.options

Class ShareFileSetPropertiesOptions

java.lang.Object

com.azure.storage.file.share.options.ShareFileSetPropertiesOptions

public class ShareFileSetPropertiesOptions
extends Object

Extended options that may be passed when setting properties of a file.

Constructor Summary

Constructors

Constructor	Description
ShareFileSetPropertiesOptions(long sizeInBytes)	Creates a new instance of ShareFileSetPropertiesOptions.

Method Summary

Modifier and Type	Method	Description
ShareFilePermission	getFilePermissions()	Gets the ShareFilePermission.
ShareFileHttpHeaders	getHttpHeaders()	Gets the file's http headers.
FilePosixProperties	getPosixProperties()	Optional properties to set on NFS files.
ShareRequestConditions	getRequestConditions()	Gets the ShareRequestConditions.
long	getSizeInBytes()	Gets the new size for the file share.
FileSmbProperties	getSmbProperties()	Gets the optional SMB properties to set on the destination file or directory.
ShareFileSetPropertiesOptions	setFilePermissions(ShareFilePermission filePermissions)	Sets the ShareFilePermission.
ShareFileSetPropertiesOptions	setHttpHeaders(ShareFileHttpHeaders httpHeaders)	Sets the file's http headers.
ShareFileSetPropertiesOptions	setPosixProperties(FilePosixProperties posixProperties)	Optional properties to set on NFS files.
ShareFileSetPropertiesOptions	setRequestConditions(ShareRequestConditions requestConditions)	Sets the ShareRequestConditions.
ShareFileSetPropertiesOptions	setSmbProperties(FileSmbProperties smbProperties)	Sets the optional SMB properties to set on the destination file or directory.

Methods inherited from class java.lang.Object

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

Constructor Details

ShareFileSetPropertiesOptions

public ShareFileSetPropertiesOptions(long sizeInBytes)

Creates a new instance of ShareFileSetPropertiesOptions.

Parameters:

sizeInBytes - Specifies the new size for the file share in bytes. If the specified byte value is less than the current size of the file, then all ranges above the specified byte value are cleared.

Method Details

getSizeInBytes

public long getSizeInBytes()

Gets the new size for the file share.

Returns:

Gets the new size for the file share.

getHttpHeaders

public ShareFileHttpHeaders getHttpHeaders()

Gets the file's http headers.

Returns:

the file's http headers.

setHttpHeaders

public ShareFileSetPropertiesOptions setHttpHeaders(ShareFileHttpHeaders httpHeaders)

Sets the file's http headers.

Parameters:

httpHeaders - the http headers.

Returns:

the updated options.

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.

setSmbProperties

public ShareFileSetPropertiesOptions 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.

getFilePermissions

public ShareFilePermission getFilePermissions()

Gets the ShareFilePermission.

Returns:

ShareFilePermission

setFilePermissions

public ShareFileSetPropertiesOptions setFilePermissions(ShareFilePermission filePermissions)

Sets the ShareFilePermission.

Parameters:

filePermissions - ShareFilePermission

Returns:

The updated options.

getRequestConditions

public ShareRequestConditions getRequestConditions()

Gets the ShareRequestConditions.

Returns:

ShareRequestConditions

setRequestConditions

public ShareFileSetPropertiesOptions setRequestConditions(ShareRequestConditions requestConditions)

Sets the ShareRequestConditions.

Parameters:

requestConditions - ShareRequestConditions

Returns:

The updated options.

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

setPosixProperties

public ShareFileSetPropertiesOptions 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.