Package com.azure.storage.file.datalake.options

Class DataLakePathCreateOptions

java.lang.Object
com.azure.storage.file.datalake.options.DataLakePathCreateOptions
public class DataLakePathCreateOptions extends Object
Extended options that may be passed when creating a datalake resource.

  • Constructor Details

    • DataLakePathCreateOptions

      public DataLakePathCreateOptions()
      Optional parameters for creating a file or directory.

  • Method Details

    • getPermissions

      public String getPermissions()
      Returns:
      the permissions

    • setPermissions

      public DataLakePathCreateOptions setPermissions(String permissions)
      Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.
      Parameters:
      permissions - The permissions.
      Returns:
      the updated options.

    • getUmask

      public String getUmask()
      Returns:
      the umask.

    • setUmask

      public DataLakePathCreateOptions setUmask(String umask)
      When creating a file or directory and the parent folder does not have a default ACL, the umask restricts the permissions of the file or directory to be created. The resulting permission is given by p bitwise-and ^u, where p is the permission and u is the umask. For example, if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission is 0777 for a directory and 0666 for a file. The default umask is 0027. The umask must be specified in 4-digit octal notation (e.g. 0766).
      Parameters:
      umask - The umask.
      Returns:
      the updated options.

    • getAccessControlList

      public List<PathAccessControlEntry> getAccessControlList()
      Returns:
      the POSIX access control list for the file/directory.

    • setAccessControlList

      public DataLakePathCreateOptions setAccessControlList(List<PathAccessControlEntry> accessControl)
      Optional. The POSIX access control list for the file or directory.
      Parameters:
      accessControl - The access control list.
      Returns:
      The updated options.

    • getOwner

      public String getOwner()
      Returns:
      the name of owner of the file/directory.

    • setOwner

      public DataLakePathCreateOptions setOwner(String owner)
      Optional. Sets the owner of the file/directory.
      Parameters:
      owner - the new owner.
      Returns:
      The updated options.

    • getGroup

      public String getGroup()
      Returns:
      the name of owning group of the file/directory.

    • setGroup

      public DataLakePathCreateOptions setGroup(String group)
      Optional. Sets the owning group of the file/directory.
      Parameters:
      group - the new owning group.
      Returns:
      The updated options.

    • getScheduleDeletionOptions

      public DataLakePathScheduleDeletionOptions getScheduleDeletionOptions()
      Returns:
      the DataLakePathScheduleDeletionOptions set on the path.

    • setScheduleDeletionOptions

      public DataLakePathCreateOptions setScheduleDeletionOptions(DataLakePathScheduleDeletionOptions deletionOptions)
      Scheduled deletion options to set on the path.
      Parameters:
      deletionOptions - the DataLakePathScheduleDeletionOptions to set.
      Returns:
      the updated options.

    • getPathHttpHeaders

      public PathHttpHeaders getPathHttpHeaders()
      Gets the http header properties.
      Returns:
      the http headers.

    • setPathHttpHeaders

      public DataLakePathCreateOptions setPathHttpHeaders(PathHttpHeaders headers)
      Optional standard HTTP header properties that can be set for the new file or directory.
      Parameters:
      headers - The http headers.
      Returns:
      the updated options.

    • getMetadata

      public Map<String,String> getMetadata()
      Returns:
      Metadata associated with the datalake path.

    • setMetadata

      public DataLakePathCreateOptions setMetadata(Map<String,String> metadata)
      Optional custom metadata to set for this file or directory.
      Parameters:
      metadata - Metadata to associate with the datalake path. If there is leading or trailing whitespace in any metadata key or value, it must be removed or encoded.
      Returns:
      The updated options.

    • getRequestConditions

      public DataLakeRequestConditions getRequestConditions()
      Optional DataLakeRequestConditions conditions on the creation of this file or directory.
      Returns:
      the request conditions.

    • setRequestConditions

      public DataLakePathCreateOptions setRequestConditions(DataLakeRequestConditions requestConditions)
      Optional DataLakeRequestConditions conditions on the creation of this file or directory. Sets the request conditions.
      Parameters:
      requestConditions - The request conditions.
      Returns:
      The updated options.

    • getSourceLeaseId

      public String getSourceLeaseId()
      Returns:
      the source lease ID

    • setSourceLeaseId

      public DataLakePathCreateOptions setSourceLeaseId(String leaseId)
      Sets the source lease ID.
      Parameters:
      leaseId - the source lease ID.
      Returns:
      The updated options.

    • getProposedLeaseId

      public String getProposedLeaseId()
      Returns:
      the proposed lease ID.

    • setProposedLeaseId

      public DataLakePathCreateOptions setProposedLeaseId(String leaseId)
      Optional. Sets proposed lease ID. Does not apply to directories.
      Parameters:
      leaseId - the proposed lease ID.
      Returns:
      The updated options.

    • getLeaseDuration

      public Integer getLeaseDuration()
      Returns:
      the lease duration in seconds.

    • setLeaseDuration

      public DataLakePathCreateOptions setLeaseDuration(Integer duration)
      Optional. Specifies the duration of the lease, in seconds, or specify -1 for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. Does not apply to directories. Sets the lease duration.
      Parameters:
      duration - the new duration.
      Returns:
      The updated options.