Share via

ShareFileCreateSymbolicLinkOptions Class

Package:
com.azure.storage.file.share.options
Maven Artifact:
com.azure:azure-storage-file-share:12.27.1
  • java.lang.Object
    • com.azure.storage.file.share.options.ShareFileCreateSymbolicLinkOptions

public class ShareFileCreateSymbolicLinkOptions

NFS only. Options that may be passed when creating a symbolic link for a file.

Constructor Summary

Constructor Description
ShareFileCreateSymbolicLinkOptions(String linkText)

Creates a new instance of ShareFileCreateSymbolicLinkOptions.

Method Summary

Modifier and Type Method and Description
OffsetDateTime getFileCreationTime()

Optional creation time of the symbolic link.
OffsetDateTime getFileLastWriteTime()

Optional last write time of the symbolic link.
String getGroup()

Optional.
String getLinkText()

Required.
Map<String,String> getMetadata()

Optional custom metadata to set for the symbolic link.
String getOwner()

Optional.
ShareRequestConditions getRequestConditions()

Optional ShareRequestConditions to add conditions on creating the symbolic link.
ShareFileCreateSymbolicLinkOptions setFileCreationTime(OffsetDateTime fileCreationTime)

Optional creation time of the symbolic link.
ShareFileCreateSymbolicLinkOptions setFileLastWriteTime(OffsetDateTime fileLastWriteTime)

Optional last write time of the symbolic link.
ShareFileCreateSymbolicLinkOptions setGroup(String group)

Optional.
ShareFileCreateSymbolicLinkOptions setMetadata(Map<String,String> metadata)

Optional custom metadata to set for the symbolic link.
ShareFileCreateSymbolicLinkOptions setOwner(String owner)

Optional.
ShareFileCreateSymbolicLinkOptions setRequestConditions(ShareRequestConditions requestConditions)

Optional ShareRequestConditions to add conditions on creating the symbolic link.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ShareFileCreateSymbolicLinkOptions

public ShareFileCreateSymbolicLinkOptions(String linkText)

Creates a new instance of ShareFileCreateSymbolicLinkOptions.

Parameters:

linkText - The absolute or relative path of the file to be linked to.

Method Details

getFileCreationTime

public OffsetDateTime getFileCreationTime()

Optional creation time of the symbolic link.

Returns:

the creation time of the symbolic link.

getFileLastWriteTime

public OffsetDateTime getFileLastWriteTime()

Optional last write time of the symbolic link.

Returns:

the last write time of the symbolic link.

getGroup

public String getGroup()

Optional. The owner group identifier (GID) to be set on the symbolic link. The default value is 0 (root group).

Returns:

the group for the creation of the symbolic link.

getLinkText

public String getLinkText()

Required. The absolute or relative path of the file to be linked to.

Returns:

the absolute or relative path of the file to be linked to.

getMetadata

public Map<String,String> getMetadata()

Optional custom metadata to set for the symbolic link.

Returns:

the custom metadata for the creation of the symbolic link.

getOwner

public String getOwner()

Optional. The owner user identifier (UID) to be set on the symbolic link. The default value is 0 (root).

Returns:

the owner for the creation of the symbolic link.

getRequestConditions

public ShareRequestConditions getRequestConditions()

Optional ShareRequestConditions to add conditions on creating the symbolic link.

Returns:

the ShareRequestConditions for the creation of the symbolic link.

setFileCreationTime

public ShareFileCreateSymbolicLinkOptions setFileCreationTime(OffsetDateTime fileCreationTime)

Optional creation time of the symbolic link.

Parameters:

fileCreationTime - the creation time of the symbolic link.

Returns:

the updated options.

setFileLastWriteTime

public ShareFileCreateSymbolicLinkOptions setFileLastWriteTime(OffsetDateTime fileLastWriteTime)

Optional last write time of the symbolic link.

Parameters:

fileLastWriteTime - the last write time of the symbolic link.

Returns:

the updated options.

setGroup

public ShareFileCreateSymbolicLinkOptions setGroup(String group)

Optional. The owner group identifier (GID) to be set on the symbolic link. The default value is 0 (root group).

Parameters:

group - the group for the creation of the symbolic link.

Returns:

the updated options.

setMetadata

public ShareFileCreateSymbolicLinkOptions setMetadata(Map<String,String> metadata)

Optional custom metadata to set for the symbolic link.

Parameters:

metadata - the custom metadata for the creation of the symbolic link.

Returns:

the updated options.

setOwner

public ShareFileCreateSymbolicLinkOptions setOwner(String owner)

Optional. The owner user identifier (UID) to be set on the symbolic link. The default value is 0 (root).

Parameters:

owner - the owner for the creation of the symbolic link.

Returns:

the updated options.

setRequestConditions

public ShareFileCreateSymbolicLinkOptions setRequestConditions(ShareRequestConditions requestConditions)

Optional ShareRequestConditions to add conditions on creating the symbolic link.

Parameters:

requestConditions - ShareRequestConditions

Returns:

the updated options.

Applies to