azure-docs-sdk-java/docs-ref-autogen/com.azure.storage.file.data...

594 строки
89 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient"
name: "DataLakePathAsyncClient"
nameWithType: "DataLakePathAsyncClient"
summary: "This class provides a client that contains all operations that apply to any path object."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **DataLakePathAsyncClient**"
methods:
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.create()"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.create()"
name: "create()"
nameWithType: "DataLakePathAsyncClient.create()"
summary: "Creates a resource."
syntax: "public Mono<PathInfo> create()"
desc: "Creates a resource. By default, this method will not overwrite an existing path.\n\n**Code Samples**\n\n```java\nclient.create().subscribe(response ->\n System.out.printf(\"Last Modified Time:%s\", response.getLastModified()));\n```\n\nFor more information see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create"
returns:
description: "A reactive response containing information about the created resource."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.storage.file.datalake.models.PathInfo?alt=com.azure.storage.file.datalake.models.PathInfo&text=PathInfo\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.create(boolean)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.create(boolean overwrite)"
name: "create(boolean overwrite)"
nameWithType: "DataLakePathAsyncClient.create(boolean overwrite)"
summary: "Creates a resource."
parameters:
- description: "Whether to overwrite, should data exist on the file."
name: "overwrite"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<PathInfo> create(boolean overwrite)"
desc: "Creates a resource.\n\n**Code Samples**\n\n```java\nboolean overwrite = true;\n client.create(overwrite).subscribe(response ->\n System.out.printf(\"Last Modified Time:%s\", response.getLastModified()));\n```\n\nFor more information see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create"
returns:
description: "A reactive response containing information about the created resource."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.storage.file.datalake.models.PathInfo?alt=com.azure.storage.file.datalake.models.PathInfo&text=PathInfo\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.createIfNotExists()"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.createIfNotExists()"
name: "createIfNotExists()"
nameWithType: "DataLakePathAsyncClient.createIfNotExists()"
summary: "Creates a resource if it does not exist."
syntax: "public Mono<PathInfo> createIfNotExists()"
desc: "Creates a resource if it does not exist.\n\n**Code Samples**\n\n```java\nclient.createIfNotExists().subscribe(response ->\n System.out.printf(\"Created at %s%n\", response.getLastModified()));\n```\n\nFor more information see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create"
returns:
description: "A reactive response signaling completion. <xref uid=\"com.azure.storage.file.datalake.models.PathInfo\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PathInfo\"></xref> contains information about the created resource."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.storage.file.datalake.models.PathInfo?alt=com.azure.storage.file.datalake.models.PathInfo&text=PathInfo\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.createIfNotExistsWithResponse(com.azure.storage.file.datalake.options.DataLakePathCreateOptions)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.createIfNotExistsWithResponse(DataLakePathCreateOptions options)"
name: "createIfNotExistsWithResponse(DataLakePathCreateOptions options)"
nameWithType: "DataLakePathAsyncClient.createIfNotExistsWithResponse(DataLakePathCreateOptions options)"
summary: "Creates a resource if it does not exist."
parameters:
- description: "<xref uid=\"com.azure.storage.file.datalake.options.DataLakePathCreateOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakePathCreateOptions\"></xref>"
name: "options"
type: "<xref href=\"com.azure.storage.file.datalake.options.DataLakePathCreateOptions?alt=com.azure.storage.file.datalake.options.DataLakePathCreateOptions&text=DataLakePathCreateOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<PathInfo>> createIfNotExistsWithResponse(DataLakePathCreateOptions options)"
desc: "Creates a resource if it does not exist.\n\n**Code Samples**\n\n```java\nPathHttpHeaders headers = new PathHttpHeaders()\n .setContentLanguage(\"en-US\")\n .setContentType(\"binary\");\n String permissions = \"permissions\";\n String umask = \"umask\";\n Map<String, String> metadata = Collections.singletonMap(\"metadata\", \"value\");\n DataLakePathCreateOptions options = new DataLakePathCreateOptions()\n .setPermissions(permissions)\n .setUmask(umask)\n .setPathHttpHeaders(headers)\n .setMetadata(metadata);\n\n client.createIfNotExistsWithResponse(options).subscribe(response -> {\n if (response.getStatusCode() == 409) {\n System.out.println(\"Already exists.\");\n } else {\n System.out.println(\"successfully created.\");\n }\n });\n```\n\nFor more information see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> signaling completion, whose <xref uid=\"com.azure.core.http.rest.Response.getValue*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"value\"></xref>\n contains a <xref uid=\"com.azure.storage.file.datalake.models.PathInfo\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PathInfo\"></xref> containing information about the resource. If <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>'s status code is\n 201, a new resource was successfully created. If status code is 409, a resource already existed at this location."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.file.datalake.models.PathInfo?alt=com.azure.storage.file.datalake.models.PathInfo&text=PathInfo\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.createWithResponse(com.azure.storage.file.datalake.options.DataLakePathCreateOptions)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.createWithResponse(DataLakePathCreateOptions options)"
name: "createWithResponse(DataLakePathCreateOptions options)"
nameWithType: "DataLakePathAsyncClient.createWithResponse(DataLakePathCreateOptions options)"
summary: "Creates a resource."
parameters:
- description: "<xref uid=\"com.azure.storage.file.datalake.options.DataLakePathCreateOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakePathCreateOptions\"></xref>"
name: "options"
type: "<xref href=\"com.azure.storage.file.datalake.options.DataLakePathCreateOptions?alt=com.azure.storage.file.datalake.options.DataLakePathCreateOptions&text=DataLakePathCreateOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<PathInfo>> createWithResponse(DataLakePathCreateOptions options)"
desc: "Creates a resource.\n\n**Code Samples**\n\n```java\nPathHttpHeaders httpHeaders = new PathHttpHeaders()\n .setContentLanguage(\"en-US\")\n .setContentType(\"binary\");\n DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()\n .setLeaseId(leaseId);\n Map<String, String> metadata = Collections.singletonMap(\"metadata\", \"value\");\n String permissions = \"permissions\";\n String umask = \"umask\";\n String owner = \"rwx\";\n String group = \"r--\";\n String leaseId = CoreUtils.randomUuid().toString();\n Integer duration = 15;\n DataLakePathCreateOptions options = new DataLakePathCreateOptions()\n .setPermissions(permissions)\n .setUmask(umask)\n .setOwner(owner)\n .setGroup(group)\n .setPathHttpHeaders(httpHeaders)\n .setRequestConditions(requestConditions)\n .setMetadata(metadata)\n .setProposedLeaseId(leaseId)\n .setLeaseDuration(duration);\n\n client.createWithResponse(options).subscribe(response ->\n System.out.printf(\"Last Modified Time:%s\", response.getValue().getLastModified()));\n```\n\nFor more information see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing a <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> whose <xref uid=\"com.azure.core.http.rest.Response.getValue*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"value\"></xref> contains a <xref uid=\"com.azure.storage.file.datalake.models.PathItem\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PathItem\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.file.datalake.models.PathInfo?alt=com.azure.storage.file.datalake.models.PathInfo&text=PathInfo\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.createWithResponse(java.lang.String,java.lang.String,com.azure.storage.file.datalake.models.PathHttpHeaders,java.util.Map<java.lang.String,java.lang.String>,com.azure.storage.file.datalake.models.DataLakeRequestConditions)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.createWithResponse(String permissions, String umask, PathHttpHeaders headers, Map<String,String> metadata, DataLakeRequestConditions requestConditions)"
name: "createWithResponse(String permissions, String umask, PathHttpHeaders headers, Map<String,String> metadata, DataLakeRequestConditions requestConditions)"
nameWithType: "DataLakePathAsyncClient.createWithResponse(String permissions, String umask, PathHttpHeaders headers, Map<String,String> metadata, DataLakeRequestConditions requestConditions)"
summary: "Creates a resource."
parameters:
- description: "POSIX access permissions for the resource owner, the resource owning group, and others."
name: "permissions"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Restricts permissions of the resource to be created."
name: "umask"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "<xref uid=\"com.azure.storage.file.datalake.models.PathHttpHeaders\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PathHttpHeaders\"></xref>"
name: "headers"
type: "<xref href=\"com.azure.storage.file.datalake.models.PathHttpHeaders?alt=com.azure.storage.file.datalake.models.PathHttpHeaders&text=PathHttpHeaders\" data-throw-if-not-resolved=\"False\" />"
- description: "Metadata to associate with the resource. If there is leading or trailing whitespace in any\n metadata key or value, it must be removed or encoded."
name: "metadata"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- description: "<xref uid=\"com.azure.storage.file.datalake.models.DataLakeRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeRequestConditions\"></xref>"
name: "requestConditions"
type: "<xref href=\"com.azure.storage.file.datalake.models.DataLakeRequestConditions?alt=com.azure.storage.file.datalake.models.DataLakeRequestConditions&text=DataLakeRequestConditions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<PathInfo>> createWithResponse(String permissions, String umask, PathHttpHeaders headers, Map<String,String> metadata, DataLakeRequestConditions requestConditions)"
desc: "Creates a resource.\n\n**Code Samples**\n\n```java\nPathHttpHeaders httpHeaders = new PathHttpHeaders()\n .setContentLanguage(\"en-US\")\n .setContentType(\"binary\");\n DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()\n .setLeaseId(leaseId);\n String permissions = \"permissions\";\n String umask = \"umask\";\n\n client.createWithResponse(permissions, umask, httpHeaders, Collections.singletonMap(\"metadata\", \"value\"),\n requestConditions)\n .subscribe(response -> System.out.printf(\"Last Modified Time:%s\", response.getValue().getLastModified()));\n```\n\nFor more information see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing a <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> whose <xref uid=\"com.azure.core.http.rest.Response.getValue*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"value\"></xref> contains a <xref uid=\"com.azure.storage.file.datalake.models.PathItem\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PathItem\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.file.datalake.models.PathInfo?alt=com.azure.storage.file.datalake.models.PathInfo&text=PathInfo\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.deleteIfExists()"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.deleteIfExists()"
name: "deleteIfExists()"
nameWithType: "DataLakePathAsyncClient.deleteIfExists()"
summary: "Deletes paths under the resource if it exists."
syntax: "public Mono<Boolean> deleteIfExists()"
desc: "Deletes paths under the resource if it exists.\n\n**Code Samples**\n\n```java\nclient.deleteIfExists().subscribe(\n response -> System.out.printf(\"Delete completed%n\"),\n error -> System.out.printf(\"Delete failed: %s%n\", error));\n```\n\nFor more information see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create"
returns:
description: "a reactive response signaling completion. <code>true</code> indicates that the resource under the path was\n successfully deleted, <code>false</code> indicates the resource did not exist."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.deleteIfExistsWithResponse(com.azure.storage.file.datalake.options.DataLakePathDeleteOptions)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.deleteIfExistsWithResponse(DataLakePathDeleteOptions options)"
name: "deleteIfExistsWithResponse(DataLakePathDeleteOptions options)"
nameWithType: "DataLakePathAsyncClient.deleteIfExistsWithResponse(DataLakePathDeleteOptions options)"
summary: "Deletes all paths under the specified resource if exists."
parameters:
- description: "<xref uid=\"com.azure.storage.file.datalake.options.DataLakePathDeleteOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakePathDeleteOptions\"></xref>"
name: "options"
type: "<xref href=\"com.azure.storage.file.datalake.options.DataLakePathDeleteOptions?alt=com.azure.storage.file.datalake.options.DataLakePathDeleteOptions&text=DataLakePathDeleteOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<Boolean>> deleteIfExistsWithResponse(DataLakePathDeleteOptions options)"
desc: "Deletes all paths under the specified resource if exists.\n\n**Code Samples**\n\n```java\nDataLakeRequestConditions requestConditions = new DataLakeRequestConditions()\n .setLeaseId(leaseId);\n\n DataLakePathDeleteOptions options = new DataLakePathDeleteOptions().setIsRecursive(false)\n .setRequestConditions(requestConditions);\n\n client.deleteIfExistsWithResponse(options).subscribe(response -> {\n if (response.getStatusCode() == 404) {\n System.out.println(\"Does not exist.\");\n } else {\n System.out.println(\"successfully deleted.\");\n }\n });\n```\n\nFor more information see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete"
returns:
description: "A reactive response signaling completion. If <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>'s status code is 200, the resource was\n successfully deleted. If status code is 404, the resource does not exist."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>&gt;&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.exists()"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.exists()"
name: "exists()"
nameWithType: "DataLakePathAsyncClient.exists()"
summary: "Determines if the path this client represents exists in the cloud."
syntax: "public Mono<Boolean> exists()"
desc: "Determines if the path this client represents exists in the cloud.\n\nNote that this method does not guarantee that the path type (file/directory) matches expectations.\n\nFor example, a DataLakeFileClient representing a path to a datalake directory will return true, and vice versa.\n\n**Code Samples**\n\n```java\nclient.exists().subscribe(response -> System.out.printf(\"Exists? %b%n\", response));\n```"
returns:
description: "true if the path exists, false if it doesn't"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.existsWithResponse()"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.existsWithResponse()"
name: "existsWithResponse()"
nameWithType: "DataLakePathAsyncClient.existsWithResponse()"
summary: "Determines if the path this client represents exists in the cloud."
syntax: "public Mono<Response<Boolean>> existsWithResponse()"
desc: "Determines if the path this client represents exists in the cloud.\n\nNote that this method does not guarantee that the path type (file/directory) matches expectations.\n\nFor example, a DataLakeFileClient representing a path to a datalake directory will return true, and vice versa.\n\n**Code Samples**\n\n```java\nclient.existsWithResponse().subscribe(response -> System.out.printf(\"Exists? %b%n\", response.getValue()));\n```"
returns:
description: "true if the path exists, false if it doesn't"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>&gt;&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.generateSas(com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.generateSas(DataLakeServiceSasSignatureValues dataLakeServiceSasSignatureValues)"
name: "generateSas(DataLakeServiceSasSignatureValues dataLakeServiceSasSignatureValues)"
nameWithType: "DataLakePathAsyncClient.generateSas(DataLakeServiceSasSignatureValues dataLakeServiceSasSignatureValues)"
summary: "Generates a service SAS for the path using the specified <xref uid=\"com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeServiceSasSignatureValues\"></xref>"
parameters:
- description: "<xref uid=\"com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeServiceSasSignatureValues\"></xref>"
name: "dataLakeServiceSasSignatureValues"
type: "<xref href=\"com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues?alt=com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues&text=DataLakeServiceSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
syntax: "public String generateSas(DataLakeServiceSasSignatureValues dataLakeServiceSasSignatureValues)"
desc: "Generates a service SAS for the path using the specified <xref uid=\"com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeServiceSasSignatureValues\"></xref>\n\nNote : The client must be authenticated via <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"StorageSharedKeyCredential\"></xref>\n\nSee <xref uid=\"com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeServiceSasSignatureValues\"></xref> for more information on how to construct a service SAS.\n\n**Code Samples**\n\n```java\nOffsetDateTime expiryTime = OffsetDateTime.now().plusDays(1);\n PathSasPermission permission = new PathSasPermission().setReadPermission(true);\n\n DataLakeServiceSasSignatureValues values = new DataLakeServiceSasSignatureValues(expiryTime, permission)\n .setStartTime(OffsetDateTime.now());\n\n client.generateSas(values); // Client must be authenticated via StorageSharedKeyCredential\n```"
returns:
description: "A <code>String</code> representing the SAS query parameters."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.generateSas(com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues,com.azure.core.util.Context)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.generateSas(DataLakeServiceSasSignatureValues dataLakeServiceSasSignatureValues, Context context)"
name: "generateSas(DataLakeServiceSasSignatureValues dataLakeServiceSasSignatureValues, Context context)"
nameWithType: "DataLakePathAsyncClient.generateSas(DataLakeServiceSasSignatureValues dataLakeServiceSasSignatureValues, Context context)"
summary: "Generates a service SAS for the path using the specified <xref uid=\"com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeServiceSasSignatureValues\"></xref>"
parameters:
- description: "<xref uid=\"com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeServiceSasSignatureValues\"></xref>"
name: "dataLakeServiceSasSignatureValues"
type: "<xref href=\"com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues?alt=com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues&text=DataLakeServiceSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
- description: "Additional context that is passed through the code when generating a SAS."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public String generateSas(DataLakeServiceSasSignatureValues dataLakeServiceSasSignatureValues, Context context)"
desc: "Generates a service SAS for the path using the specified <xref uid=\"com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeServiceSasSignatureValues\"></xref>\n\nNote : The client must be authenticated via <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"StorageSharedKeyCredential\"></xref>\n\nSee <xref uid=\"com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeServiceSasSignatureValues\"></xref> for more information on how to construct a service SAS.\n\n**Code Samples**\n\n```java\nOffsetDateTime expiryTime = OffsetDateTime.now().plusDays(1);\n PathSasPermission permission = new PathSasPermission().setReadPermission(true);\n\n DataLakeServiceSasSignatureValues values = new DataLakeServiceSasSignatureValues(expiryTime, permission)\n .setStartTime(OffsetDateTime.now());\n\n // Client must be authenticated via StorageSharedKeyCredential\n client.generateSas(values, new Context(\"key\", \"value\"));\n```"
returns:
description: "A <code>String</code> representing the SAS query parameters."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.generateUserDelegationSas(com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues,com.azure.storage.file.datalake.models.UserDelegationKey)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.generateUserDelegationSas(DataLakeServiceSasSignatureValues dataLakeServiceSasSignatureValues, UserDelegationKey userDelegationKey)"
name: "generateUserDelegationSas(DataLakeServiceSasSignatureValues dataLakeServiceSasSignatureValues, UserDelegationKey userDelegationKey)"
nameWithType: "DataLakePathAsyncClient.generateUserDelegationSas(DataLakeServiceSasSignatureValues dataLakeServiceSasSignatureValues, UserDelegationKey userDelegationKey)"
summary: "Generates a user delegation SAS for the path using the specified <xref uid=\"com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeServiceSasSignatureValues\"></xref>."
parameters:
- description: "<xref uid=\"com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeServiceSasSignatureValues\"></xref>"
name: "dataLakeServiceSasSignatureValues"
type: "<xref href=\"com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues?alt=com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues&text=DataLakeServiceSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
- description: "A <xref uid=\"com.azure.storage.file.datalake.models.UserDelegationKey\" data-throw-if-not-resolved=\"false\" data-raw-source=\"UserDelegationKey\"></xref> object used to sign the SAS values.\n See <xref uid=\"com.azure.storage.file.datalake.DataLakeServiceAsyncClient.getUserDelegationKey(java.time.OffsetDateTime,java.time.OffsetDateTime)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeServiceAsyncClient#getUserDelegationKey(OffsetDateTime, OffsetDateTime)\"></xref> for more information\n on how to get a user delegation key."
name: "userDelegationKey"
type: "<xref href=\"com.azure.storage.file.datalake.models.UserDelegationKey?alt=com.azure.storage.file.datalake.models.UserDelegationKey&text=UserDelegationKey\" data-throw-if-not-resolved=\"False\" />"
syntax: "public String generateUserDelegationSas(DataLakeServiceSasSignatureValues dataLakeServiceSasSignatureValues, UserDelegationKey userDelegationKey)"
desc: "Generates a user delegation SAS for the path using the specified <xref uid=\"com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeServiceSasSignatureValues\"></xref>.\n\nSee <xref uid=\"com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeServiceSasSignatureValues\"></xref> for more information on how to construct a user delegation SAS.\n\n**Code Samples**\n\n```java\nOffsetDateTime myExpiryTime = OffsetDateTime.now().plusDays(1);\n PathSasPermission myPermission = new PathSasPermission().setReadPermission(true);\n\n DataLakeServiceSasSignatureValues myValues = new DataLakeServiceSasSignatureValues(expiryTime, permission)\n .setStartTime(OffsetDateTime.now());\n\n client.generateUserDelegationSas(values, userDelegationKey);\n```"
returns:
description: "A <code>String</code> representing the SAS query parameters."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.generateUserDelegationSas(com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues,com.azure.storage.file.datalake.models.UserDelegationKey,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.generateUserDelegationSas(DataLakeServiceSasSignatureValues dataLakeServiceSasSignatureValues, UserDelegationKey userDelegationKey, String accountName, Context context)"
name: "generateUserDelegationSas(DataLakeServiceSasSignatureValues dataLakeServiceSasSignatureValues, UserDelegationKey userDelegationKey, String accountName, Context context)"
nameWithType: "DataLakePathAsyncClient.generateUserDelegationSas(DataLakeServiceSasSignatureValues dataLakeServiceSasSignatureValues, UserDelegationKey userDelegationKey, String accountName, Context context)"
summary: "Generates a user delegation SAS for the path using the specified <xref uid=\"com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeServiceSasSignatureValues\"></xref>."
parameters:
- description: "<xref uid=\"com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeServiceSasSignatureValues\"></xref>"
name: "dataLakeServiceSasSignatureValues"
type: "<xref href=\"com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues?alt=com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues&text=DataLakeServiceSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
- description: "A <xref uid=\"com.azure.storage.file.datalake.models.UserDelegationKey\" data-throw-if-not-resolved=\"false\" data-raw-source=\"UserDelegationKey\"></xref> object used to sign the SAS values.\n See <xref uid=\"com.azure.storage.file.datalake.DataLakeServiceAsyncClient.getUserDelegationKey(java.time.OffsetDateTime,java.time.OffsetDateTime)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeServiceAsyncClient#getUserDelegationKey(OffsetDateTime, OffsetDateTime)\"></xref> for more information\n on how to get a user delegation key."
name: "userDelegationKey"
type: "<xref href=\"com.azure.storage.file.datalake.models.UserDelegationKey?alt=com.azure.storage.file.datalake.models.UserDelegationKey&text=UserDelegationKey\" data-throw-if-not-resolved=\"False\" />"
- description: "The account name."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Additional context that is passed through the code when generating a SAS."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public String generateUserDelegationSas(DataLakeServiceSasSignatureValues dataLakeServiceSasSignatureValues, UserDelegationKey userDelegationKey, String accountName, Context context)"
desc: "Generates a user delegation SAS for the path using the specified <xref uid=\"com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeServiceSasSignatureValues\"></xref>.\n\nSee <xref uid=\"com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeServiceSasSignatureValues\"></xref> for more information on how to construct a user delegation SAS.\n\n**Code Samples**\n\n```java\nOffsetDateTime myExpiryTime = OffsetDateTime.now().plusDays(1);\n PathSasPermission myPermission = new PathSasPermission().setReadPermission(true);\n\n DataLakeServiceSasSignatureValues myValues = new DataLakeServiceSasSignatureValues(expiryTime, permission)\n .setStartTime(OffsetDateTime.now());\n\n client.generateUserDelegationSas(values, userDelegationKey, accountName, new Context(\"key\", \"value\"));\n```"
returns:
description: "A <code>String</code> representing the SAS query parameters."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.getAccessControl()"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.getAccessControl()"
name: "getAccessControl()"
nameWithType: "DataLakePathAsyncClient.getAccessControl()"
summary: "Returns the access control for a resource."
syntax: "public Mono<PathAccessControl> getAccessControl()"
desc: "Returns the access control for a resource.\n\n**Code Samples**\n\n```java\nclient.getAccessControl().subscribe(\n response -> System.out.printf(\"Access Control List: %s, Group: %s, Owner: %s, Permissions: %s\",\n PathAccessControlEntry.serializeList(response.getAccessControlList()), response.getGroup(),\n response.getOwner(), response.getPermissions()));\n```\n\nFor more information, see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties"
returns:
description: "A reactive response containing the resource access control."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.storage.file.datalake.models.PathAccessControl?alt=com.azure.storage.file.datalake.models.PathAccessControl&text=PathAccessControl\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.getAccessControlWithResponse(boolean,com.azure.storage.file.datalake.models.DataLakeRequestConditions)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.getAccessControlWithResponse(boolean userPrincipalNameReturned, DataLakeRequestConditions requestConditions)"
name: "getAccessControlWithResponse(boolean userPrincipalNameReturned, DataLakeRequestConditions requestConditions)"
nameWithType: "DataLakePathAsyncClient.getAccessControlWithResponse(boolean userPrincipalNameReturned, DataLakeRequestConditions requestConditions)"
summary: "Returns the access control for a resource."
parameters:
- description: "When true, user identity values returned as User Principal Names. When false,\n user identity values returned as Azure Active Directory Object IDs. Default value is false."
name: "userPrincipalNameReturned"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- description: "<xref uid=\"com.azure.storage.file.datalake.models.DataLakeRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeRequestConditions\"></xref>"
name: "requestConditions"
type: "<xref href=\"com.azure.storage.file.datalake.models.DataLakeRequestConditions?alt=com.azure.storage.file.datalake.models.DataLakeRequestConditions&text=DataLakeRequestConditions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<PathAccessControl>> getAccessControlWithResponse(boolean userPrincipalNameReturned, DataLakeRequestConditions requestConditions)"
desc: "Returns the access control for a resource.\n\n**Code Samples**\n\n```java\nDataLakeRequestConditions requestConditions = new DataLakeRequestConditions().setLeaseId(leaseId);\n boolean userPrincipalNameReturned = false;\n\n client.getAccessControlWithResponse(userPrincipalNameReturned, requestConditions).subscribe(\n response -> System.out.printf(\"Access Control List: %s, Group: %s, Owner: %s, Permissions: %s\",\n PathAccessControlEntry.serializeList(response.getValue().getAccessControlList()),\n response.getValue().getGroup(), response.getValue().getOwner(), response.getValue().getPermissions()));\n```\n\nFor more information, see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties"
returns:
description: "A reactive response containing the resource access control."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.file.datalake.models.PathAccessControl?alt=com.azure.storage.file.datalake.models.PathAccessControl&text=PathAccessControl\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.getAccountName()"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.getAccountName()"
name: "getAccountName()"
nameWithType: "DataLakePathAsyncClient.getAccountName()"
summary: "Gets the associated account name."
syntax: "public String getAccountName()"
desc: "Gets the associated account name."
returns:
description: "Account name associated with this storage resource."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.getCustomerProvidedKey()"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.getCustomerProvidedKey()"
name: "getCustomerProvidedKey()"
nameWithType: "DataLakePathAsyncClient.getCustomerProvidedKey()"
summary: "Gets the <xref uid=\"com.azure.storage.file.datalake.implementation.models.CpkInfo\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CpkInfo\"></xref> used to encrypt this path's content on the server."
syntax: "public CustomerProvidedKey getCustomerProvidedKey()"
desc: "Gets the <xref uid=\"com.azure.storage.file.datalake.implementation.models.CpkInfo\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CpkInfo\"></xref> used to encrypt this path's content on the server."
returns:
description: "the customer provided key used for encryption."
type: "<xref href=\"com.azure.storage.file.datalake.models.CustomerProvidedKey?alt=com.azure.storage.file.datalake.models.CustomerProvidedKey&text=CustomerProvidedKey\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.getCustomerProvidedKeyAsyncClient(com.azure.storage.file.datalake.models.CustomerProvidedKey)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.getCustomerProvidedKeyAsyncClient(CustomerProvidedKey customerProvidedKey)"
name: "getCustomerProvidedKeyAsyncClient(CustomerProvidedKey customerProvidedKey)"
nameWithType: "DataLakePathAsyncClient.getCustomerProvidedKeyAsyncClient(CustomerProvidedKey customerProvidedKey)"
summary: "Creates a new <xref uid=\"com.azure.storage.file.datalake.DataLakePathAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakePathAsyncClient\"></xref> with the specified `customerProvidedKey`."
parameters:
- description: "the <xref uid=\"com.azure.storage.file.datalake.models.CustomerProvidedKey\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CustomerProvidedKey\"></xref> for the path,\n pass <code>null</code> to use no customer provided key."
name: "customerProvidedKey"
type: "<xref href=\"com.azure.storage.file.datalake.models.CustomerProvidedKey?alt=com.azure.storage.file.datalake.models.CustomerProvidedKey&text=CustomerProvidedKey\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DataLakePathAsyncClient getCustomerProvidedKeyAsyncClient(CustomerProvidedKey customerProvidedKey)"
desc: "Creates a new <xref uid=\"com.azure.storage.file.datalake.DataLakePathAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakePathAsyncClient\"></xref> with the specified `customerProvidedKey`."
returns:
description: "a <xref uid=\"com.azure.storage.file.datalake.DataLakePathAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakePathAsyncClient\"></xref> with the specified <code>customerProvidedKey</code>."
type: "<xref href=\"com.azure.storage.file.datalake.DataLakePathAsyncClient?alt=com.azure.storage.file.datalake.DataLakePathAsyncClient&text=DataLakePathAsyncClient\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.getFileSystemName()"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.getFileSystemName()"
name: "getFileSystemName()"
nameWithType: "DataLakePathAsyncClient.getFileSystemName()"
summary: "Gets the name of the File System in which this object lives."
syntax: "public String getFileSystemName()"
desc: "Gets the name of the File System in which this object lives."
returns:
description: "The name of the File System."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.getHttpPipeline()"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.getHttpPipeline()"
name: "getHttpPipeline()"
nameWithType: "DataLakePathAsyncClient.getHttpPipeline()"
summary: "Gets the <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> powering this client."
syntax: "public HttpPipeline getHttpPipeline()"
desc: "Gets the <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> powering this client."
returns:
description: "The pipeline."
type: "<xref href=\"com.azure.core.http.HttpPipeline?alt=com.azure.core.http.HttpPipeline&text=HttpPipeline\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.getProperties()"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.getProperties()"
name: "getProperties()"
nameWithType: "DataLakePathAsyncClient.getProperties()"
summary: "Returns the resource's metadata and properties."
syntax: "public Mono<PathProperties> getProperties()"
desc: "Returns the resource's metadata and properties.\n\n**Code Samples**\n\n```java\nclient.getProperties().subscribe(response ->\n System.out.printf(\"Creation Time: %s, Size: %d%n\", response.getCreationTime(), response.getFileSize()));\n```\n\nFor more information, see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/get-blob-properties"
returns:
description: "A reactive response containing the resource's properties and metadata."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.storage.file.datalake.models.PathProperties?alt=com.azure.storage.file.datalake.models.PathProperties&text=PathProperties\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.getProperties(com.azure.storage.file.datalake.options.PathGetPropertiesOptions)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.getProperties(PathGetPropertiesOptions options)"
name: "getProperties(PathGetPropertiesOptions options)"
nameWithType: "DataLakePathAsyncClient.getProperties(PathGetPropertiesOptions options)"
summary: "Returns the resource's metadata and properties."
parameters:
- description: "<xref uid=\"com.azure.storage.file.datalake.options.PathGetPropertiesOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PathGetPropertiesOptions\"></xref>"
name: "options"
type: "<xref href=\"com.azure.storage.file.datalake.options.PathGetPropertiesOptions?alt=com.azure.storage.file.datalake.options.PathGetPropertiesOptions&text=PathGetPropertiesOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<PathProperties> getProperties(PathGetPropertiesOptions options)"
desc: "Returns the resource's metadata and properties.\n\n**Code Samples**\n\n```java\nPathGetPropertiesOptions options = new PathGetPropertiesOptions().setUserPrincipalName(true);\n\n client.getProperties(options).subscribe(response ->\n System.out.printf(\"Creation Time: %s, Size: %d%n\", response.getCreationTime(), response.getFileSize()));\n```\n\nFor more information, see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/get-blob-properties"
returns:
description: "A reactive response containing the resource's properties and metadata."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.storage.file.datalake.models.PathProperties?alt=com.azure.storage.file.datalake.models.PathProperties&text=PathProperties\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.getPropertiesWithResponse(com.azure.storage.file.datalake.models.DataLakeRequestConditions)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.getPropertiesWithResponse(DataLakeRequestConditions requestConditions)"
name: "getPropertiesWithResponse(DataLakeRequestConditions requestConditions)"
nameWithType: "DataLakePathAsyncClient.getPropertiesWithResponse(DataLakeRequestConditions requestConditions)"
summary: "Returns the resource's metadata and properties."
parameters:
- description: "<xref uid=\"com.azure.storage.file.datalake.models.DataLakeRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeRequestConditions\"></xref>"
name: "requestConditions"
type: "<xref href=\"com.azure.storage.file.datalake.models.DataLakeRequestConditions?alt=com.azure.storage.file.datalake.models.DataLakeRequestConditions&text=DataLakeRequestConditions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<PathProperties>> getPropertiesWithResponse(DataLakeRequestConditions requestConditions)"
desc: "Returns the resource's metadata and properties.\n\n**Code Samples**\n\n```java\nDataLakeRequestConditions requestConditions = new DataLakeRequestConditions().setLeaseId(leaseId);\n\n client.getPropertiesWithResponse(requestConditions).subscribe(\n response -> System.out.printf(\"Creation Time: %s, Size: %d%n\", response.getValue().getCreationTime(),\n response.getValue().getFileSize()));\n```\n\nFor more information, see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/get-blob-properties"
returns:
description: "A reactive response containing the resource's properties and metadata."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.file.datalake.models.PathProperties?alt=com.azure.storage.file.datalake.models.PathProperties&text=PathProperties\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.getServiceVersion()"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.getServiceVersion()"
name: "getServiceVersion()"
nameWithType: "DataLakePathAsyncClient.getServiceVersion()"
summary: "Gets the service version the client is using."
syntax: "public DataLakeServiceVersion getServiceVersion()"
desc: "Gets the service version the client is using."
returns:
description: "the service version the client is using."
type: "<xref href=\"com.azure.storage.file.datalake.DataLakeServiceVersion?alt=com.azure.storage.file.datalake.DataLakeServiceVersion&text=DataLakeServiceVersion\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.removeAccessControlRecursive(java.util.List<com.azure.storage.file.datalake.models.PathRemoveAccessControlEntry>)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.removeAccessControlRecursive(List<PathRemoveAccessControlEntry> accessControlList)"
name: "removeAccessControlRecursive(List<PathRemoveAccessControlEntry> accessControlList)"
nameWithType: "DataLakePathAsyncClient.removeAccessControlRecursive(List<PathRemoveAccessControlEntry> accessControlList)"
summary: "Recursively removes the access control on a path and all subpaths."
parameters:
- description: "The POSIX access control list for the file or directory."
name: "accessControlList"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.storage.file.datalake.models.PathRemoveAccessControlEntry?alt=com.azure.storage.file.datalake.models.PathRemoveAccessControlEntry&text=PathRemoveAccessControlEntry\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public Mono<AccessControlChangeResult> removeAccessControlRecursive(List<PathRemoveAccessControlEntry> accessControlList)"
desc: "Recursively removes the access control on a path and all subpaths.\n\n**Code Samples**\n\n```java\nPathRemoveAccessControlEntry pathAccessControlEntry = new PathRemoveAccessControlEntry()\n .setEntityId(\"entityId\");\n List<PathRemoveAccessControlEntry> pathAccessControlEntries = new ArrayList<>();\n pathAccessControlEntries.add(pathAccessControlEntry);\n\n client.removeAccessControlRecursive(pathAccessControlEntries).subscribe(\n response -> System.out.printf(\"Successful changed file operations: %d\",\n response.getCounters().getChangedFilesCount()));\n```\n\nFor more information, see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update"
returns:
description: "A reactive response containing the result of the operation."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.storage.file.datalake.models.AccessControlChangeResult?alt=com.azure.storage.file.datalake.models.AccessControlChangeResult&text=AccessControlChangeResult\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.removeAccessControlRecursiveWithResponse(com.azure.storage.file.datalake.options.PathRemoveAccessControlRecursiveOptions)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.removeAccessControlRecursiveWithResponse(PathRemoveAccessControlRecursiveOptions options)"
name: "removeAccessControlRecursiveWithResponse(PathRemoveAccessControlRecursiveOptions options)"
nameWithType: "DataLakePathAsyncClient.removeAccessControlRecursiveWithResponse(PathRemoveAccessControlRecursiveOptions options)"
summary: "Recursively removes the access control on a path and all subpaths."
parameters:
- description: "<xref uid=\"com.azure.storage.file.datalake.options.PathRemoveAccessControlRecursiveOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PathRemoveAccessControlRecursiveOptions\"></xref>"
name: "options"
type: "<xref href=\"com.azure.storage.file.datalake.options.PathRemoveAccessControlRecursiveOptions?alt=com.azure.storage.file.datalake.options.PathRemoveAccessControlRecursiveOptions&text=PathRemoveAccessControlRecursiveOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<AccessControlChangeResult>> removeAccessControlRecursiveWithResponse(PathRemoveAccessControlRecursiveOptions options)"
desc: "Recursively removes the access control on a path and all subpaths.\n\n**Code Samples**\n\n```java\nPathRemoveAccessControlEntry pathAccessControlEntry = new PathRemoveAccessControlEntry()\n .setEntityId(\"entityId\");\n List<PathRemoveAccessControlEntry> pathAccessControlEntries = new ArrayList<>();\n pathAccessControlEntries.add(pathAccessControlEntry);\n\n Integer batchSize = 2;\n Integer maxBatches = 10;\n boolean continueOnFailure = false;\n String continuationToken = null;\n Consumer<Response<AccessControlChanges>> progressHandler =\n response -> System.out.println(\"Received response\");\n\n PathRemoveAccessControlRecursiveOptions options =\n new PathRemoveAccessControlRecursiveOptions(pathAccessControlEntries)\n .setBatchSize(batchSize)\n .setMaxBatches(maxBatches)\n .setContinueOnFailure(continueOnFailure)\n .setContinuationToken(continuationToken)\n .setProgressHandler(progressHandler);\n\n client.removeAccessControlRecursive(pathAccessControlEntries).subscribe(\n response -> System.out.printf(\"Successful changed file operations: %d\",\n response.getCounters().getChangedFilesCount()));\n```\n\nFor more information, see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update"
returns:
description: "A reactive response containing the result of the operation."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.file.datalake.models.AccessControlChangeResult?alt=com.azure.storage.file.datalake.models.AccessControlChangeResult&text=AccessControlChangeResult\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.setAccessControlList(java.util.List<com.azure.storage.file.datalake.models.PathAccessControlEntry>,java.lang.String,java.lang.String)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.setAccessControlList(List<PathAccessControlEntry> accessControlList, String group, String owner)"
name: "setAccessControlList(List<PathAccessControlEntry> accessControlList, String group, String owner)"
nameWithType: "DataLakePathAsyncClient.setAccessControlList(List<PathAccessControlEntry> accessControlList, String group, String owner)"
summary: "Changes the access control list, group and/or owner for a resource."
parameters:
- description: "A list of <xref uid=\"com.azure.storage.file.datalake.models.PathAccessControlEntry\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PathAccessControlEntry\"></xref> objects."
name: "accessControlList"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.storage.file.datalake.models.PathAccessControlEntry?alt=com.azure.storage.file.datalake.models.PathAccessControlEntry&text=PathAccessControlEntry\" data-throw-if-not-resolved=\"False\" />&gt;"
- description: "The group of the resource."
name: "group"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The owner of the resource."
name: "owner"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<PathInfo> setAccessControlList(List<PathAccessControlEntry> accessControlList, String group, String owner)"
desc: "Changes the access control list, group and/or owner for a resource.\n\n**Code Samples**\n\n```java\nPathAccessControlEntry pathAccessControlEntry = new PathAccessControlEntry()\n .setEntityId(\"entityId\")\n .setPermissions(new RolePermissions().setReadPermission(true));\n List<PathAccessControlEntry> pathAccessControlEntries = new ArrayList<>();\n pathAccessControlEntries.add(pathAccessControlEntry);\n String group = \"group\";\n String owner = \"owner\";\n\n client.setAccessControlList(pathAccessControlEntries, group, owner).subscribe(\n response -> System.out.printf(\"Last Modified Time: %s\", response.getLastModified()));\n```\n\nFor more information, see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update"
returns:
description: "A reactive response containing the resource info."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.storage.file.datalake.models.PathInfo?alt=com.azure.storage.file.datalake.models.PathInfo&text=PathInfo\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.setAccessControlListWithResponse(java.util.List<com.azure.storage.file.datalake.models.PathAccessControlEntry>,java.lang.String,java.lang.String,com.azure.storage.file.datalake.models.DataLakeRequestConditions)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.setAccessControlListWithResponse(List<PathAccessControlEntry> accessControlList, String group, String owner, DataLakeRequestConditions requestConditions)"
name: "setAccessControlListWithResponse(List<PathAccessControlEntry> accessControlList, String group, String owner, DataLakeRequestConditions requestConditions)"
nameWithType: "DataLakePathAsyncClient.setAccessControlListWithResponse(List<PathAccessControlEntry> accessControlList, String group, String owner, DataLakeRequestConditions requestConditions)"
summary: "Changes the access control list, group and/or owner for a resource."
parameters:
- description: "A list of <xref uid=\"com.azure.storage.file.datalake.models.PathAccessControlEntry\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PathAccessControlEntry\"></xref> objects."
name: "accessControlList"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.storage.file.datalake.models.PathAccessControlEntry?alt=com.azure.storage.file.datalake.models.PathAccessControlEntry&text=PathAccessControlEntry\" data-throw-if-not-resolved=\"False\" />&gt;"
- description: "The group of the resource."
name: "group"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The owner of the resource."
name: "owner"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "<xref uid=\"com.azure.storage.file.datalake.models.DataLakeRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeRequestConditions\"></xref>"
name: "requestConditions"
type: "<xref href=\"com.azure.storage.file.datalake.models.DataLakeRequestConditions?alt=com.azure.storage.file.datalake.models.DataLakeRequestConditions&text=DataLakeRequestConditions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<PathInfo>> setAccessControlListWithResponse(List<PathAccessControlEntry> accessControlList, String group, String owner, DataLakeRequestConditions requestConditions)"
desc: "Changes the access control list, group and/or owner for a resource.\n\n**Code Samples**\n\n```java\nDataLakeRequestConditions requestConditions = new DataLakeRequestConditions().setLeaseId(leaseId);\n PathAccessControlEntry pathAccessControlEntry = new PathAccessControlEntry()\n .setEntityId(\"entityId\")\n .setPermissions(new RolePermissions().setReadPermission(true));\n List<PathAccessControlEntry> pathAccessControlEntries = new ArrayList<>();\n pathAccessControlEntries.add(pathAccessControlEntry);\n String group = \"group\";\n String owner = \"owner\";\n\n client.setAccessControlListWithResponse(pathAccessControlEntries, group, owner, requestConditions).subscribe(\n response -> System.out.printf(\"Last Modified Time: %s\", response.getValue().getLastModified()));\n```\n\nFor more information, see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update"
returns:
description: "A reactive response containing the resource info."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.file.datalake.models.PathInfo?alt=com.azure.storage.file.datalake.models.PathInfo&text=PathInfo\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.setAccessControlRecursive(java.util.List<com.azure.storage.file.datalake.models.PathAccessControlEntry>)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.setAccessControlRecursive(List<PathAccessControlEntry> accessControlList)"
name: "setAccessControlRecursive(List<PathAccessControlEntry> accessControlList)"
nameWithType: "DataLakePathAsyncClient.setAccessControlRecursive(List<PathAccessControlEntry> accessControlList)"
summary: "Recursively sets the access control on a path and all subpaths."
parameters:
- description: "The POSIX access control list for the file or directory."
name: "accessControlList"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.storage.file.datalake.models.PathAccessControlEntry?alt=com.azure.storage.file.datalake.models.PathAccessControlEntry&text=PathAccessControlEntry\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public Mono<AccessControlChangeResult> setAccessControlRecursive(List<PathAccessControlEntry> accessControlList)"
desc: "Recursively sets the access control on a path and all subpaths.\n\n**Code Samples**\n\n```java\nPathAccessControlEntry pathAccessControlEntry = new PathAccessControlEntry()\n .setEntityId(\"entityId\")\n .setPermissions(new RolePermissions().setReadPermission(true));\n List<PathAccessControlEntry> pathAccessControlEntries = new ArrayList<>();\n pathAccessControlEntries.add(pathAccessControlEntry);\n\n client.setAccessControlRecursive(pathAccessControlEntries).subscribe(\n response -> System.out.printf(\"Successful changed file operations: %d\",\n response.getCounters().getChangedFilesCount()));\n```\n\nFor more information, see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update"
returns:
description: "A reactive response containing the result of the operation."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.storage.file.datalake.models.AccessControlChangeResult?alt=com.azure.storage.file.datalake.models.AccessControlChangeResult&text=AccessControlChangeResult\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.setAccessControlRecursiveWithResponse(com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.setAccessControlRecursiveWithResponse(PathSetAccessControlRecursiveOptions options)"
name: "setAccessControlRecursiveWithResponse(PathSetAccessControlRecursiveOptions options)"
nameWithType: "DataLakePathAsyncClient.setAccessControlRecursiveWithResponse(PathSetAccessControlRecursiveOptions options)"
summary: "Recursively sets the access control on a path and all subpaths."
parameters:
- description: "<xref uid=\"com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PathSetAccessControlRecursiveOptions\"></xref>"
name: "options"
type: "<xref href=\"com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions?alt=com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions&text=PathSetAccessControlRecursiveOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<AccessControlChangeResult>> setAccessControlRecursiveWithResponse(PathSetAccessControlRecursiveOptions options)"
desc: "Recursively sets the access control on a path and all subpaths.\n\n**Code Samples**\n\n```java\nPathAccessControlEntry pathAccessControlEntry = new PathAccessControlEntry()\n .setEntityId(\"entityId\")\n .setPermissions(new RolePermissions().setReadPermission(true));\n List<PathAccessControlEntry> pathAccessControlEntries = new ArrayList<>();\n pathAccessControlEntries.add(pathAccessControlEntry);\n\n Integer batchSize = 2;\n Integer maxBatches = 10;\n boolean continueOnFailure = false;\n String continuationToken = null;\n Consumer<Response<AccessControlChanges>> progressHandler =\n response -> System.out.println(\"Received response\");\n\n PathSetAccessControlRecursiveOptions options =\n new PathSetAccessControlRecursiveOptions(pathAccessControlEntries)\n .setBatchSize(batchSize)\n .setMaxBatches(maxBatches)\n .setContinueOnFailure(continueOnFailure)\n .setContinuationToken(continuationToken)\n .setProgressHandler(progressHandler);\n\n client.setAccessControlRecursive(pathAccessControlEntries).subscribe(\n response -> System.out.printf(\"Successful changed file operations: %d\",\n response.getCounters().getChangedFilesCount()));\n```\n\nFor more information, see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update"
returns:
description: "A reactive response containing the result of the operation."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.file.datalake.models.AccessControlChangeResult?alt=com.azure.storage.file.datalake.models.AccessControlChangeResult&text=AccessControlChangeResult\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.setHttpHeaders(com.azure.storage.file.datalake.models.PathHttpHeaders)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.setHttpHeaders(PathHttpHeaders headers)"
name: "setHttpHeaders(PathHttpHeaders headers)"
nameWithType: "DataLakePathAsyncClient.setHttpHeaders(PathHttpHeaders headers)"
summary: "Changes a resource's HTTP header properties."
parameters:
- description: "<xref uid=\"com.azure.storage.file.datalake.models.PathHttpHeaders\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PathHttpHeaders\"></xref>"
name: "headers"
type: "<xref href=\"com.azure.storage.file.datalake.models.PathHttpHeaders?alt=com.azure.storage.file.datalake.models.PathHttpHeaders&text=PathHttpHeaders\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Void> setHttpHeaders(PathHttpHeaders headers)"
desc: "Changes a resource's HTTP header properties. If only one HTTP header is updated, the others will all be erased. In order to preserve existing values, they must be passed alongside the header being changed.\n\n**Code Samples**\n\n```java\nclient.setHttpHeaders(new PathHttpHeaders()\n .setContentLanguage(\"en-US\")\n .setContentType(\"binary\"));\n```\n\nFor more information, see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/set-blob-properties"
returns:
description: "A reactive response signalling completion."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.setHttpHeadersWithResponse(com.azure.storage.file.datalake.models.PathHttpHeaders,com.azure.storage.file.datalake.models.DataLakeRequestConditions)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.setHttpHeadersWithResponse(PathHttpHeaders headers, DataLakeRequestConditions requestConditions)"
name: "setHttpHeadersWithResponse(PathHttpHeaders headers, DataLakeRequestConditions requestConditions)"
nameWithType: "DataLakePathAsyncClient.setHttpHeadersWithResponse(PathHttpHeaders headers, DataLakeRequestConditions requestConditions)"
summary: "Changes a resource's HTTP header properties."
parameters:
- description: "<xref uid=\"com.azure.storage.file.datalake.models.PathHttpHeaders\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PathHttpHeaders\"></xref>"
name: "headers"
type: "<xref href=\"com.azure.storage.file.datalake.models.PathHttpHeaders?alt=com.azure.storage.file.datalake.models.PathHttpHeaders&text=PathHttpHeaders\" data-throw-if-not-resolved=\"False\" />"
- description: "<xref uid=\"com.azure.storage.file.datalake.models.DataLakeRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeRequestConditions\"></xref>"
name: "requestConditions"
type: "<xref href=\"com.azure.storage.file.datalake.models.DataLakeRequestConditions?alt=com.azure.storage.file.datalake.models.DataLakeRequestConditions&text=DataLakeRequestConditions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<Void>> setHttpHeadersWithResponse(PathHttpHeaders headers, DataLakeRequestConditions requestConditions)"
desc: "Changes a resource's HTTP header properties. If only one HTTP header is updated, the others will all be erased. In order to preserve existing values, they must be passed alongside the header being changed.\n\n**Code Samples**\n\n```java\nDataLakeRequestConditions requestConditions = new DataLakeRequestConditions().setLeaseId(leaseId);\n\n client.setHttpHeadersWithResponse(new PathHttpHeaders()\n .setContentLanguage(\"en-US\")\n .setContentType(\"binary\"), requestConditions).subscribe(response ->\n System.out.printf(\"Set HTTP headers completed with status %d%n\", response.getStatusCode()));\n```\n\nFor more information, see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/set-blob-properties"
returns:
description: "A reactive response signalling completion."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.setMetadata(java.util.Map<java.lang.String,java.lang.String>)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.setMetadata(Map<String,String> metadata)"
name: "setMetadata(Map<String,String> metadata)"
nameWithType: "DataLakePathAsyncClient.setMetadata(Map<String,String> metadata)"
summary: "Changes a resource's metadata."
parameters:
- description: "Metadata to associate with the resource. If there is leading or trailing whitespace in any\n metadata key or value, it must be removed or encoded."
name: "metadata"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public Mono<Void> setMetadata(Map<String,String> metadata)"
desc: "Changes a resource's metadata. The specified metadata in this method will replace existing metadata. If old values must be preserved, they must be downloaded and included in the call to this method.\n\n**Code Samples**\n\n```java\nclient.setMetadata(Collections.singletonMap(\"metadata\", \"value\"))\n .subscribe(response -> System.out.println(\"Set metadata completed\"));\n```\n\nFor more information, see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/set-blob-metadata"
returns:
description: "A reactive response signalling completion."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.setMetadataWithResponse(java.util.Map<java.lang.String,java.lang.String>,com.azure.storage.file.datalake.models.DataLakeRequestConditions)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.setMetadataWithResponse(Map<String,String> metadata, DataLakeRequestConditions requestConditions)"
name: "setMetadataWithResponse(Map<String,String> metadata, DataLakeRequestConditions requestConditions)"
nameWithType: "DataLakePathAsyncClient.setMetadataWithResponse(Map<String,String> metadata, DataLakeRequestConditions requestConditions)"
summary: "Changes a resource's metadata."
parameters:
- description: "Metadata to associate with the resource. If there is leading or trailing whitespace in any\n metadata key or value, it must be removed or encoded."
name: "metadata"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- description: "<xref uid=\"com.azure.storage.file.datalake.models.DataLakeRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeRequestConditions\"></xref>"
name: "requestConditions"
type: "<xref href=\"com.azure.storage.file.datalake.models.DataLakeRequestConditions?alt=com.azure.storage.file.datalake.models.DataLakeRequestConditions&text=DataLakeRequestConditions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<Void>> setMetadataWithResponse(Map<String,String> metadata, DataLakeRequestConditions requestConditions)"
desc: "Changes a resource's metadata. The specified metadata in this method will replace existing metadata. If old values must be preserved, they must be downloaded and included in the call to this method.\n\n**Code Samples**\n\n```java\nDataLakeRequestConditions requestConditions = new DataLakeRequestConditions().setLeaseId(leaseId);\n\n client.setMetadataWithResponse(Collections.singletonMap(\"metadata\", \"value\"), requestConditions)\n .subscribe(response -> System.out.printf(\"Set metadata completed with status %d%n\",\n response.getStatusCode()));\n```\n\nFor more information, see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/set-blob-metadata"
returns:
description: "A reactive response signalling completion."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.setPermissions(com.azure.storage.file.datalake.models.PathPermissions,java.lang.String,java.lang.String)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.setPermissions(PathPermissions permissions, String group, String owner)"
name: "setPermissions(PathPermissions permissions, String group, String owner)"
nameWithType: "DataLakePathAsyncClient.setPermissions(PathPermissions permissions, String group, String owner)"
summary: "Changes the permissions, group and/or owner for a resource."
parameters:
- description: "<xref uid=\"com.azure.storage.file.datalake.models.PathPermissions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PathPermissions\"></xref>"
name: "permissions"
type: "<xref href=\"com.azure.storage.file.datalake.models.PathPermissions?alt=com.azure.storage.file.datalake.models.PathPermissions&text=PathPermissions\" data-throw-if-not-resolved=\"False\" />"
- description: "The group of the resource."
name: "group"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The owner of the resource."
name: "owner"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<PathInfo> setPermissions(PathPermissions permissions, String group, String owner)"
desc: "Changes the permissions, group and/or owner for a resource.\n\n**Code Samples**\n\n```java\nPathPermissions permissions = new PathPermissions()\n .setGroup(new RolePermissions().setExecutePermission(true).setReadPermission(true))\n .setOwner(new RolePermissions().setExecutePermission(true).setReadPermission(true).setWritePermission(true))\n .setOther(new RolePermissions().setReadPermission(true));\n String group = \"group\";\n String owner = \"owner\";\n\n client.setPermissions(permissions, group, owner).subscribe(\n response -> System.out.printf(\"Last Modified Time: %s\", response.getLastModified()));\n```\n\nFor more information, see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update"
returns:
description: "A reactive response containing the resource info."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.storage.file.datalake.models.PathInfo?alt=com.azure.storage.file.datalake.models.PathInfo&text=PathInfo\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.setPermissionsWithResponse(com.azure.storage.file.datalake.models.PathPermissions,java.lang.String,java.lang.String,com.azure.storage.file.datalake.models.DataLakeRequestConditions)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.setPermissionsWithResponse(PathPermissions permissions, String group, String owner, DataLakeRequestConditions requestConditions)"
name: "setPermissionsWithResponse(PathPermissions permissions, String group, String owner, DataLakeRequestConditions requestConditions)"
nameWithType: "DataLakePathAsyncClient.setPermissionsWithResponse(PathPermissions permissions, String group, String owner, DataLakeRequestConditions requestConditions)"
summary: "Changes the permissions, group and/or owner for a resource."
parameters:
- description: "<xref uid=\"com.azure.storage.file.datalake.models.PathPermissions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PathPermissions\"></xref>"
name: "permissions"
type: "<xref href=\"com.azure.storage.file.datalake.models.PathPermissions?alt=com.azure.storage.file.datalake.models.PathPermissions&text=PathPermissions\" data-throw-if-not-resolved=\"False\" />"
- description: "The group of the resource."
name: "group"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The owner of the resource."
name: "owner"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "<xref uid=\"com.azure.storage.file.datalake.models.DataLakeRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeRequestConditions\"></xref>"
name: "requestConditions"
type: "<xref href=\"com.azure.storage.file.datalake.models.DataLakeRequestConditions?alt=com.azure.storage.file.datalake.models.DataLakeRequestConditions&text=DataLakeRequestConditions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<PathInfo>> setPermissionsWithResponse(PathPermissions permissions, String group, String owner, DataLakeRequestConditions requestConditions)"
desc: "Changes the permissions, group and/or owner for a resource.\n\n**Code Samples**\n\n```java\nDataLakeRequestConditions requestConditions = new DataLakeRequestConditions().setLeaseId(leaseId);\n PathPermissions permissions = new PathPermissions()\n .setGroup(new RolePermissions().setExecutePermission(true).setReadPermission(true))\n .setOwner(new RolePermissions().setExecutePermission(true).setReadPermission(true).setWritePermission(true))\n .setOther(new RolePermissions().setReadPermission(true));\n String group = \"group\";\n String owner = \"owner\";\n\n client.setPermissionsWithResponse(permissions, group, owner, requestConditions).subscribe(\n response -> System.out.printf(\"Last Modified Time: %s\", response.getValue().getLastModified()));\n```\n\nFor more information, see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update"
returns:
description: "A reactive response containing the resource info."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.file.datalake.models.PathInfo?alt=com.azure.storage.file.datalake.models.PathInfo&text=PathInfo\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.updateAccessControlRecursive(java.util.List<com.azure.storage.file.datalake.models.PathAccessControlEntry>)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.updateAccessControlRecursive(List<PathAccessControlEntry> accessControlList)"
name: "updateAccessControlRecursive(List<PathAccessControlEntry> accessControlList)"
nameWithType: "DataLakePathAsyncClient.updateAccessControlRecursive(List<PathAccessControlEntry> accessControlList)"
summary: "Recursively updates the access control on a path and all subpaths."
parameters:
- description: "The POSIX access control list for the file or directory."
name: "accessControlList"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.storage.file.datalake.models.PathAccessControlEntry?alt=com.azure.storage.file.datalake.models.PathAccessControlEntry&text=PathAccessControlEntry\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public Mono<AccessControlChangeResult> updateAccessControlRecursive(List<PathAccessControlEntry> accessControlList)"
desc: "Recursively updates the access control on a path and all subpaths.\n\n**Code Samples**\n\n```java\nPathAccessControlEntry pathAccessControlEntry = new PathAccessControlEntry()\n .setEntityId(\"entityId\")\n .setPermissions(new RolePermissions().setReadPermission(true));\n List<PathAccessControlEntry> pathAccessControlEntries = new ArrayList<>();\n pathAccessControlEntries.add(pathAccessControlEntry);\n\n client.updateAccessControlRecursive(pathAccessControlEntries).subscribe(\n response -> System.out.printf(\"Successful changed file operations: %d\",\n response.getCounters().getChangedFilesCount()));\n```\n\nFor more information, see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update"
returns:
description: "A reactive response containing the result of the operation."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.storage.file.datalake.models.AccessControlChangeResult?alt=com.azure.storage.file.datalake.models.AccessControlChangeResult&text=AccessControlChangeResult\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.file.datalake.DataLakePathAsyncClient.updateAccessControlRecursiveWithResponse(com.azure.storage.file.datalake.options.PathUpdateAccessControlRecursiveOptions)"
fullName: "com.azure.storage.file.datalake.DataLakePathAsyncClient.updateAccessControlRecursiveWithResponse(PathUpdateAccessControlRecursiveOptions options)"
name: "updateAccessControlRecursiveWithResponse(PathUpdateAccessControlRecursiveOptions options)"
nameWithType: "DataLakePathAsyncClient.updateAccessControlRecursiveWithResponse(PathUpdateAccessControlRecursiveOptions options)"
summary: "Recursively updates the access control on a path and all subpaths."
parameters:
- description: "<xref uid=\"com.azure.storage.file.datalake.options.PathUpdateAccessControlRecursiveOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PathUpdateAccessControlRecursiveOptions\"></xref>"
name: "options"
type: "<xref href=\"com.azure.storage.file.datalake.options.PathUpdateAccessControlRecursiveOptions?alt=com.azure.storage.file.datalake.options.PathUpdateAccessControlRecursiveOptions&text=PathUpdateAccessControlRecursiveOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<AccessControlChangeResult>> updateAccessControlRecursiveWithResponse(PathUpdateAccessControlRecursiveOptions options)"
desc: "Recursively updates the access control on a path and all subpaths.\n\n**Code Samples**\n\n```java\nPathAccessControlEntry pathAccessControlEntry = new PathAccessControlEntry()\n .setEntityId(\"entityId\")\n .setPermissions(new RolePermissions().setReadPermission(true));\n List<PathAccessControlEntry> pathAccessControlEntries = new ArrayList<>();\n pathAccessControlEntries.add(pathAccessControlEntry);\n\n Integer batchSize = 2;\n Integer maxBatches = 10;\n boolean continueOnFailure = false;\n String continuationToken = null;\n Consumer<Response<AccessControlChanges>> progressHandler =\n response -> System.out.println(\"Received response\");\n\n PathUpdateAccessControlRecursiveOptions options =\n new PathUpdateAccessControlRecursiveOptions(pathAccessControlEntries)\n .setBatchSize(batchSize)\n .setMaxBatches(maxBatches)\n .setContinueOnFailure(continueOnFailure)\n .setContinuationToken(continuationToken)\n .setProgressHandler(progressHandler);\n\n client.updateAccessControlRecursive(pathAccessControlEntries).subscribe(\n response -> System.out.printf(\"Successful changed file operations: %d\",\n response.getCounters().getChangedFilesCount()));\n```\n\nFor more information, see the [Azure Docs][]\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update"
returns:
description: "A reactive response containing the result of the operation."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.file.datalake.models.AccessControlChangeResult?alt=com.azure.storage.file.datalake.models.AccessControlChangeResult&text=AccessControlChangeResult\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
type: "class"
desc: "This class provides a client that contains all operations that apply to any path object."
metadata: {}
package: "com.azure.storage.file.datalake"
artifact: com.azure:azure-storage-file-datalake:12.20.1