ShareAsyncClient Class
- java.
lang. Object - com.
azure. storage. file. share. ShareAsyncClient
- com.
public class ShareAsyncClient
This class provides a azureFileStorageClient that contains all the operations for interacting with a share in Azure Storage Share. Operations allowed by the azureFileStorageClient are creating and deleting the share, creating snapshots for the share, creating and deleting directories in the share and retrieving and updating properties metadata and access policies of the share.
Instantiating an Asynchronous Share Client
ShareAsyncClient client = new ShareClientBuilder()
.connectionString("${connectionString}")
.endpoint("${endpoint}")
.buildAsyncClient();
View ShareClientBuilder for additional ways to construct the azureFileStorageClient.
Method Summary
Methods inherited from java.lang.Object
Method Details
create
public Mono
Creates the share in the storage account.
Code Samples
Create the share
shareAsyncClient.create().subscribe(
response -> {
},
error -> System.err.print(error.toString()),
() -> System.out.println("Complete creating the share!")
);
For more information, see the Azure Docs.
Returns:
createDirectory
public Mono
Creates the directory in the share with the given name.
Code Samples
Create the directory "mydirectory"
shareAsyncClient.createDirectory("mydirectory").subscribe(
response -> {
},
error -> System.err.print(error.toString()),
() -> System.out.println("Complete creating the directory!")
);
For more information, see the Azure Docs.
Parameters:
Returns:
createDirectoryIfNotExists
public Mono
Creates the directory in the share with the given name if it does not exist.
Code Samples
Create the directory "mydirectory"
shareAsyncClient.createDirectoryIfNotExists("mydirectory")
.switchIfEmpty(Mono.<ShareDirectoryAsyncClient>empty()
.doOnSuccess(x -> System.out.println("Already exists.")))
.subscribe(response -> System.out.println("Create completed."));
For more information, see the Azure Docs.
Parameters:
Returns:
createDirectoryIfNotExistsWithResponse
public Mono
Creates the directory in the share with the given name and associates the passed metadata to it if it does not exist.
Code Samples
Create the directory "documents" with metadata "directory:metadata"
FileSmbProperties smbProperties = new FileSmbProperties();
String filePermission = "filePermission";
Map<String, String> metadata = Collections.singletonMap("directory", "metadata");
ShareDirectoryCreateOptions options = new ShareDirectoryCreateOptions().setSmbProperties(smbProperties)
.setFilePermission(filePermission).setMetadata(metadata);
shareAsyncClient.createDirectoryIfNotExistsWithResponse("documents", options).subscribe(response -> {
if (response.getStatusCode() == 409) {
System.out.println("Already exists.");
} else {
System.out.println("successfully created.");
}
});
For more information, see the Azure Docs.
Parameters:
Returns:
createDirectoryWithResponse
public Mono
Creates the directory in the share with the given name and associates the passed metadata to it.
Code Samples
Create the directory "documents" with metadata "directory:metadata"
FileSmbProperties smbProperties = new FileSmbProperties();
String filePermission = "filePermission";
shareAsyncClient.createDirectoryWithResponse("documents", smbProperties, filePermission,
Collections.singletonMap("directory", "metadata"))
.subscribe(response -> System.out.printf("Creating the directory completed with status code %d",
response.getStatusCode()));
For more information, see the Azure Docs.
Parameters:
Returns:
createFile
public Mono
Creates the file in the share with the given name and file max size.
Code Samples
Create the file "myfile" with size of 1024 bytes.
shareAsyncClient.createFile("myfile", 1024).subscribe(
response -> {
},
error -> System.err.print(error.toString()),
() -> System.out.println("Complete creating the directory!")
);
For more information, see the Azure Docs.
Parameters:
Returns:
createFileWithResponse
public Mono
Creates the file in the share with the given name, file max size and associates the passed properties to it.
Code Samples
Create the file "myfile" with length of 1024 bytes, some headers, file smb properties and metadata
ShareFileHttpHeaders httpHeaders = new ShareFileHttpHeaders()
.setContentType("text/html")
.setContentEncoding("gzip")
.setContentLanguage("en")
.setCacheControl("no-transform")
.setContentDisposition("attachment");
FileSmbProperties smbProperties = new FileSmbProperties()
.setNtfsFileAttributes(EnumSet.of(NtfsFileAttributes.READ_ONLY))
.setFileCreationTime(OffsetDateTime.now())
.setFileLastWriteTime(OffsetDateTime.now())
.setFilePermissionKey("filePermissionKey");
String filePermission = "filePermission";
// NOTE: filePermission and filePermissionKey should never be both set
shareAsyncClient.createFileWithResponse("myfile", 1024, httpHeaders, smbProperties,
filePermission, Collections.singletonMap("directory", "metadata"))
.subscribe(response -> System.out.printf("Creating the file completed with status code %d",
response.getStatusCode()));
For more information, see the Azure Docs.
Parameters:
Returns:
createFileWithResponse
public Mono
Creates the file in the share with the given name, file max size and associates the passed properties to it.
Code Samples
Create the file "myfile" with length of 1024 bytes, some headers, file smb properties and metadata
ShareFileHttpHeaders httpHeaders = new ShareFileHttpHeaders()
.setContentType("text/html")
.setContentEncoding("gzip")
.setContentLanguage("en")
.setCacheControl("no-transform")
.setContentDisposition("attachment");
FileSmbProperties smbProperties = new FileSmbProperties()
.setNtfsFileAttributes(EnumSet.of(NtfsFileAttributes.READ_ONLY))
.setFileCreationTime(OffsetDateTime.now())
.setFileLastWriteTime(OffsetDateTime.now())
.setFilePermissionKey("filePermissionKey");
String filePermission = "filePermission";
// NOTE: filePermission and filePermissionKey should never be both set
ShareRequestConditions requestConditions = new ShareRequestConditions().setLeaseId(leaseId);
shareAsyncClient.createFileWithResponse("myfile", 1024, httpHeaders, smbProperties,
filePermission, Collections.singletonMap("directory", "metadata"), requestConditions)
.subscribe(response -> System.out.printf("Creating the file completed with status code %d",
response.getStatusCode()));
For more information, see the Azure Docs.
Parameters:
Returns:
createIfNotExists
public Mono
Creates the share in the storage account if it does not exist.
Code Samples
Create the share
shareAsyncClient.createIfNotExists().subscribe(response ->
System.out.printf("Created at %s%n", response.getLastModified()));
For more information, see the Azure Docs.
Returns:
createIfNotExistsWithResponse
public Mono
Creates the share in the storage account with the specified options if it does not exist.
Code Samples
Create the share with optional parameters
shareAsyncClient.createIfNotExistsWithResponse(new ShareCreateOptions()
.setMetadata(Collections.singletonMap("share", "metadata")).setQuotaInGb(1)
.setAccessTier(ShareAccessTier.HOT)).subscribe(response -> {
if (response.getStatusCode() == 409) {
System.out.println("Already exists.");
} else {
System.out.println("successfully created.");
}
});
For more information, see the Azure Docs.
Parameters:
Returns:
createPermission
public Mono
Creates a permission at the share level. If a permission already exists, it returns the key of it, else creates a new permission and returns the key.
Code Samples
ShareFilePermission permission = new ShareFilePermission().setPermission("filePermission")
.setPermissionFormat(FilePermissionFormat.BINARY);
shareAsyncClient.createPermission(permission).subscribe(
response -> System.out.printf("The file permission key is %s", response));
Parameters:
Returns:
createPermission
public Mono
Creates a permission at the share level. If a permission already exists, it returns the key of it, else creates a new permission and returns the key.
Code Samples
shareAsyncClient.createPermission("filePermission").subscribe(
response -> System.out.printf("The file permission key is %s", response));
Parameters:
Returns:
createPermissionWithResponse
public Mono
Creates a permission at the share level. If a permission already exists, it returns the key of it, else creates a new permission and returns the key.
Code Samples
ShareFilePermission permission = new ShareFilePermission().setPermission("filePermission")
.setPermissionFormat(FilePermissionFormat.BINARY);
shareAsyncClient.createPermissionWithResponse(permission).subscribe(
response -> System.out.printf("The file permission key is %s", response.getValue()));
Parameters:
Returns:
createPermissionWithResponse
public Mono
Creates a permission at the share level. If a permission already exists, it returns the key of it, else creates a new permission and returns the key.
Code Samples
shareAsyncClient.createPermissionWithResponse("filePermission").subscribe(
response -> System.out.printf("The file permission key is %s", response.getValue()));
Parameters:
Returns:
createSnapshot
public Mono
Creates a snapshot of the share with the same metadata associated to the share at the time of creation.
Code Samples
Create a snapshot
shareAsyncClient.createSnapshot().subscribe(
response -> System.out.println("Successfully creating the share snapshot with snapshot id: "
+ response.getSnapshot()),
error -> System.err.println(error.toString()),
() -> System.out.println("Complete creating the share snapshot.")
);
For more information, see the Azure Docs.
Returns:
createSnapshotWithResponse
public Mono
Creates a snapshot of the share with the metadata that was passed associated to the snapshot.
Code Samples
Create a snapshot with metadata "snapshot:metadata"
shareAsyncClient.createSnapshotWithResponse(Collections.singletonMap("snapshot", "metadata")).subscribe(
response -> System.out.println("Successfully creating the share snapshot with snapshot id: "
+ response.getValue().getSnapshot()),
error -> System.err.println(error.toString()),
() -> System.out.println("Complete creating the share snapshot.")
);
For more information, see the Azure Docs.
Parameters:
null the metadata of the share will
be copied to the snapshot.
Returns:
createWithResponse
public Mono
Creates the share in the storage account with the specified options.
Code Samples
Create the share with optional parameters
shareAsyncClient.createWithResponse(new ShareCreateOptions()
.setMetadata(Collections.singletonMap("share", "metadata")).setQuotaInGb(1)
.setAccessTier(ShareAccessTier.HOT)).subscribe(
response -> System.out.printf("Creating the share completed with status code %d",
response.getStatusCode()),
error -> System.err.print(error.toString()),
() -> System.out.println("Complete creating the share!")
);
For more information, see the Azure Docs.
Parameters:
Returns:
createWithResponse
public Mono
Creates the share in the storage account with the specified metadata and quota.
Code Samples
Create the share with metadata "share:metadata"
shareAsyncClient.createWithResponse(Collections.singletonMap("share", "metadata"), null).subscribe(
response -> System.out.printf("Creating the share completed with status code %d", response.getStatusCode()),
error -> System.err.print(error.toString()),
() -> System.out.println("Complete creating the share!")
);
Create the share with a quota of 10 GB
shareAsyncClient.createWithResponse(null, 10).subscribe(
response -> System.out.printf("Creating the share completed with status code %d", response.getStatusCode()),
error -> System.err.print(error.toString()),
() -> System.out.println("Complete creating the share!")
);
For more information, see the Azure Docs.
For more information on updated max file share size values, see the Azure Docs.
Parameters:
Returns:
delete
public Mono
Deletes the share in the storage account
Code Samples
Delete the share
shareAsyncClient.delete().subscribe(
response -> System.out.println("Deleting the shareAsyncClient completed."),
error -> System.err.println(error.toString()),
() -> System.out.println("Complete deleting the share.")
);
For more information, see the Azure Docs.
Returns:
deleteDirectory
public Mono
Deletes the specified directory in the share.
Code Samples
Delete the directory "mydirectory"
shareAsyncClient.deleteDirectory("mydirectory").subscribe(
response -> {
},
error -> System.err.println(error.toString()),
() -> System.out.println("Complete deleting the directory.")
);
For more information, see the Azure Docs.
Parameters:
Returns:
deleteDirectoryIfExists
public Mono
Deletes the specified directory in the share if exists.
Code Samples
Delete the directory "mydirectory"
shareAsyncClient.deleteDirectoryIfExists("mydirectory").subscribe(deleted -> {
if (deleted) {
System.out.println("Successfully deleted.");
} else {
System.out.println("Does not exist.");
}
});
For more information, see the Azure Docs.
Parameters:
Returns:
true indicates that the directory was successfully
deleted, false indicates that the directory did not exist.deleteDirectoryIfExistsWithResponse
public Mono
Deletes the specified directory in the share if it exists.
Code Samples
Delete the directory "mydirectory"
shareAsyncClient.deleteDirectoryIfExistsWithResponse("mydirectory").subscribe(response -> {
if (response.getStatusCode() == 404) {
System.out.println("Does not exist.");
} else {
System.out.println("successfully deleted.");
}
});
For more information, see the Azure Docs.
Parameters:
Returns:
deleteDirectoryWithResponse
public Mono
Deletes the specified directory in the share.
Code Samples
Delete the directory "mydirectory"
shareAsyncClient.deleteDirectory("mydirectory").subscribe(
response -> {
},
error -> System.err.println(error.toString()),
() -> System.out.println("Complete deleting the directory.")
);
For more information, see the Azure Docs.
Parameters:
Returns:
deleteFile
public Mono
Deletes the specified file in the share.
Code Samples
Delete the file "myfile"
shareAsyncClient.deleteFile("myfile").subscribe(
response -> {
},
error -> System.err.println(error.toString()),
() -> System.out.println("Complete deleting the file.")
);
For more information, see the Azure Docs.
Parameters:
Returns:
deleteFileIfExists
public Mono
Deletes the specified file in the share if it exists.
Code Samples
Delete the file "myfile"
shareAsyncClient.deleteFileIfExists("myfile").subscribe(deleted -> {
if (deleted) {
System.out.println("Successfully deleted.");
} else {
System.out.println("Does not exist.");
}
});
For more information, see the Azure Docs.
Parameters:
Returns:
true indicates that the file was successfully
deleted, false indicates that the file did not exist.deleteFileIfExistsWithResponse
public Mono
Deletes the specified file in the share if it exists.
Code Samples
Delete the file "myfile"
ShareRequestConditions requestConditions = new ShareRequestConditions().setLeaseId(leaseId);
shareAsyncClient.deleteFileIfExistsWithResponse("myfile", requestConditions).subscribe(response -> {
if (response.getStatusCode() == 404) {
System.out.println("Does not exist.");
} else {
System.out.println("successfully deleted.");
}
});
For more information, see the Azure Docs.
Parameters:
Returns:
deleteFileWithResponse
public Mono
Deletes the specified file in the share.
Code Samples
Delete the file "myfile"
shareAsyncClient.deleteFile("myfile").subscribe(
response -> {
},
error -> System.err.println(error.toString()),
() -> System.out.println("Complete deleting the file.")
);
For more information, see the Azure Docs.
Parameters:
Returns:
deleteFileWithResponse
public Mono
Deletes the specified file in the share.
Code Samples
Delete the file "myfile"
ShareRequestConditions requestConditions = new ShareRequestConditions().setLeaseId(leaseId);
shareAsyncClient.deleteFileWithResponse("myfile", requestConditions).subscribe(
response -> {
},
error -> System.err.println(error.toString()),
() -> System.out.println("Complete deleting the file.")
);
For more information, see the Azure Docs.
Parameters:
Returns:
deleteIfExists
public Mono
Deletes the share in the storage account if it exists.
Code Samples
Delete the share
shareAsyncClient.deleteIfExists().subscribe(deleted -> {
if (deleted) {
System.out.println("Successfully deleted.");
} else {
System.out.println("Does not exist.");
}
});
For more information, see the Azure Docs.
Returns:
true indicates that the share was successfully
deleted, false indicates that the share did not exist.deleteIfExistsWithResponse
public Mono
Deletes the share in the storage account if it exists
Code Samples
Delete the share
shareAsyncClient.deleteIfExistsWithResponse(new ShareDeleteOptions()
.setRequestConditions(new ShareRequestConditions().setLeaseId(leaseId))).subscribe(response -> {
if (response.getStatusCode() == 404) {
System.out.println("Does not exist.");
} else {
System.out.println("successfully deleted.");
}
});
For more information, see the Azure Docs.
Parameters:
Returns:
deleteWithResponse
public Mono
Deletes the share in the storage account
Code Samples
Delete the share
shareAsyncClient.deleteWithResponse().subscribe(
response -> System.out.println("Deleting the shareAsyncClient completed with status code: "
+ response.getStatusCode()),
error -> System.err.println(error.toString()),
() -> System.out.println("Complete deleting the share.")
);
For more information, see the Azure Docs.
Returns:
deleteWithResponse
public Mono
Deletes the share in the storage account
Code Samples
Delete the share
shareAsyncClient.deleteWithResponse(new ShareDeleteOptions()
.setRequestConditions(new ShareRequestConditions().setLeaseId(leaseId))).subscribe(
response -> System.out.println("Deleting the shareAsyncClient completed with status code: "
+ response.getStatusCode()), error -> System.err.println(error.toString()),
() -> System.out.println("Complete deleting the share.")
);
For more information, see the Azure Docs.
Parameters:
Returns:
exists
public Mono
Determines if the share this client represents exists in the cloud.
Code Samples
client.exists().subscribe(response -> System.out.printf("Exists? %b%n", response));
Returns:
existsWithResponse
public Mono
Determines if the share this client represents exists in the cloud.
Code Samples
client.existsWithResponse().subscribe(response -> System.out.printf("Exists? %b%n", response.getValue()));
Returns:
generateSas
public String generateSas(ShareServiceSasSignatureValues shareServiceSasSignatureValues)
Generates a service sas for the queue using the specified ShareServiceSasSignatureValues
Note : The client must be authenticated via StorageSharedKeyCredential
See ShareServiceSasSignatureValues for more information on how to construct a service SAS.
Code Samples
OffsetDateTime expiryTime = OffsetDateTime.now().plusDays(1);
ShareSasPermission permission = new ShareSasPermission().setReadPermission(true);
ShareServiceSasSignatureValues values = new ShareServiceSasSignatureValues(expiryTime, permission)
.setStartTime(OffsetDateTime.now());
shareAsyncClient.generateSas(values); // Client must be authenticated via StorageSharedKeyCredential
Parameters:
Returns:
String representing the SAS query parameters.generateSas
public String generateSas(ShareServiceSasSignatureValues shareServiceSasSignatureValues, Context context)
Generates a service sas for the queue using the specified ShareServiceSasSignatureValues
Note : The client must be authenticated via StorageSharedKeyCredential
See ShareServiceSasSignatureValues for more information on how to construct a service SAS.
Code Samples
OffsetDateTime expiryTime = OffsetDateTime.now().plusDays(1);
ShareSasPermission permission = new ShareSasPermission().setReadPermission(true);
ShareServiceSasSignatureValues values = new ShareServiceSasSignatureValues(expiryTime, permission)
.setStartTime(OffsetDateTime.now());
// Client must be authenticated via StorageSharedKeyCredential
shareAsyncClient.generateSas(values, new Context("key", "value"));
Parameters:
Returns:
String representing the SAS query parameters.generateSas
public String generateSas(ShareServiceSasSignatureValues shareServiceSasSignatureValues, Consumer
Generates a service sas for the queue using the specified ShareServiceSasSignatureValues
Note : The client must be authenticated via StorageSharedKeyCredential
See ShareServiceSasSignatureValues for more information on how to construct a service SAS.
Parameters:
Returns:
String representing the SAS query parameters.getAccessPolicy
public PagedFlux
Retrieves stored access policies specified for the share.
Code Samples
List the stored access policies
shareAsyncClient.getAccessPolicy()
.subscribe(result -> System.out.printf("Access policy %s allows these permissions: %s", result.getId(),
result.getAccessPolicy().getPermissions())
);
For more information, see the Azure Docs.
Returns:
getAccessPolicy
public PagedFlux
Retrieves stored access policies specified for the share.
Code Samples
List the stored access policies
shareAsyncClient.getAccessPolicy(new ShareGetAccessPolicyOptions()
.setRequestConditions(new ShareRequestConditions().setLeaseId(leaseId)))
.subscribe(result -> System.out.printf("Access policy %s allows these permissions: %s", result.getId(),
result.getAccessPolicy().getPermissions())
);
For more information, see the Azure Docs.
Parameters:
Returns:
getAccountName
public String getAccountName()
Get associated account name.
Returns:
getAccountUrl
public String getAccountUrl()
Get the url of the storage account.
Returns:
getDirectoryClient
public ShareDirectoryAsyncClient getDirectoryClient(String directoryName)
Constructs a ShareDirectoryAsyncClient that interacts with the specified directory.
If the directory doesn't exist in the share create() in the azureFileStorageClient will need to be called before interaction with the directory can happen.
Parameters:
Returns:
getFileClient
public ShareFileAsyncClient getFileClient(String filePath)
Constructs a ShareFileAsyncClient that interacts with the specified file.
If the file doesn't exist in the share create(long maxSize) ) create} in the client will need to be called before interaction with the file can happen.
Parameters:
Returns:
getHttpPipeline
public HttpPipeline getHttpPipeline()
Gets the HttpPipeline powering this client.
Returns:
getPermission
public Mono
Gets a permission for a given key.
Code Samples
shareAsyncClient.getPermission("filePermissionKey").subscribe(
response -> System.out.printf("The file permission is %s", response));
Parameters:
Returns:
getPermission
public Mono
Gets a permission for a given key.
Code Samples
FilePermissionFormat filePermissionFormat = FilePermissionFormat.BINARY;
shareAsyncClient.getPermission("filePermissionKey", filePermissionFormat).subscribe(
response -> System.out.printf("The file permission is %s", response));
Parameters:
Returns:
getPermissionWithResponse
public Mono
Gets a permission for a given key.
Code Samples
shareAsyncClient.getPermissionWithResponse("filePermissionKey").subscribe(
response -> System.out.printf("The file permission is %s", response.getValue()));
Parameters:
Returns:
getPermissionWithResponse
public Mono
Gets a permission for a given key.
Code Samples
FilePermissionFormat filePermissionFormat = FilePermissionFormat.BINARY;
shareAsyncClient.getPermissionWithResponse("filePermissionKey", filePermissionFormat).subscribe(
response -> System.out.printf("The file permission is %s", response.getValue()));
Parameters:
Returns:
getProperties
public Mono
Retrieves the properties of the share, these include the metadata associated to it and the quota that the share is restricted to.
Code Samples
Retrieve the share properties
shareAsyncClient.getProperties()
.subscribe(properties -> {
System.out.printf("Share quota: %d, Metadata: %s", properties.getQuota(), properties.getMetadata());
});
For more information, see the Azure Docs.
Returns:
getPropertiesWithResponse
public Mono
Retrieves the properties of the share, these include the metadata associated with it and the quota that the share is restricted to.
Code Samples
Retrieve the share properties
shareAsyncClient.getPropertiesWithResponse()
.subscribe(properties -> {
System.out.printf("Share quota: %d, Metadata: %s", properties.getValue().getQuota(),
properties.getValue().getMetadata());
});
For more information, see the Azure Docs.
Returns:
getPropertiesWithResponse
public Mono
Retrieves the properties of the share, these include the metadata associated with it and the quota that the share is restricted to.
Code Samples
Retrieve the share properties
shareAsyncClient.getPropertiesWithResponse(new ShareGetPropertiesOptions()
.setRequestConditions(new ShareRequestConditions().setLeaseId(leaseId)))
.subscribe(properties -> {
System.out.printf("Share quota: %d, Metadata: %s", properties.getValue().getQuota(),
properties.getValue().getMetadata());
});
For more information, see the Azure Docs.
Parameters:
Returns:
getRootDirectoryClient
public ShareDirectoryAsyncClient getRootDirectoryClient()
Constructs a ShareDirectoryAsyncClient that interacts with the root directory in the share.
If the directory doesn't exist in the share create() in the azureFileStorageClient will need to be called before interaction with the directory can happen.
Returns:
getServiceVersion
public ShareServiceVersion getServiceVersion()
Gets the service version the client is using.
Returns:
getShareName
public String getShareName()
Get share name from share client.
Code Samples
String shareName = shareAsyncClient.getShareName();
System.out.println("The name of the share is " + shareName);
Returns:
getShareUrl
public String getShareUrl()
Get the url of the storage share client.
Returns:
getSnapshotClient
public ShareAsyncClient getSnapshotClient(String snapshot)
Creates a new ShareAsyncClient linked to the snapshot of this share resource.
Parameters:
Returns:
getSnapshotId
public String getSnapshotId()
Get snapshot id which attached to ShareAsyncClient. Return null if no snapshot id attached.
Code Samples
Get the share snapshot id.
OffsetDateTime currentTime = OffsetDateTime.of(LocalDateTime.now(), ZoneOffset.UTC);
ShareAsyncClient shareAsyncClient = new ShareClientBuilder()
.endpoint("https://${accountName}.file.core.windows.net")
.sasToken("${SASToken}")
.shareName("myshare")
.snapshot(currentTime.toString())
.buildAsyncClient();
System.out.printf("Snapshot ID: %s%n", shareAsyncClient.getSnapshotId());
Returns:
DateTime value that identifies the share snapshot to its base
share.getStatistics
public Mono
Retrieves storage statistics about the share.
Code Samples
Retrieve the storage statistics
shareAsyncClient.getStatistics().doOnSuccess(response -> System.out.printf("The share is using %d GB",
response.getShareUsageInGB()));
For more information, see the Azure Docs.
Returns:
getStatisticsWithResponse
public Mono
Retrieves storage statistics about the share.
Code Samples
Retrieve the storage statistics
shareAsyncClient.getStatisticsWithResponse().subscribe(response -> System.out.printf("The share is using %d GB",
response.getValue().getShareUsageInGB()));
For more information, see the Azure Docs.
Returns:
getStatisticsWithResponse
public Mono
Retrieves storage statistics about the share.
Code Samples
Retrieve the storage statistics
shareAsyncClient.getStatisticsWithResponse(new ShareGetStatisticsOptions()
.setRequestConditions(new ShareRequestConditions().setLeaseId(leaseId)))
.subscribe(response -> System.out.printf("The share is using %d GB",
response.getValue().getShareUsageInGB()));
For more information, see the Azure Docs.
Parameters:
Returns:
setAccessPolicy
public Mono
Sets stored access policies for the share.
Code Samples
Set a read only stored access policy
ShareAccessPolicy accessPolicy = new ShareAccessPolicy().setPermissions("r")
.setStartsOn(OffsetDateTime.now(ZoneOffset.UTC))
.setExpiresOn(OffsetDateTime.now(ZoneOffset.UTC).plusDays(10));
ShareSignedIdentifier permission = new ShareSignedIdentifier().setId("mypolicy").setAccessPolicy(accessPolicy);
shareAsyncClient.setAccessPolicy(Collections.singletonList(permission)).doOnSuccess(
response -> System.out.println("Setting access policies completed."));
For more information, see the Azure Docs.
Parameters:
Returns:
setAccessPolicyWithResponse
public Mono
Sets stored access policies for the share.
Code Samples
Set a read only stored access policy
ShareAccessPolicy accessPolicy = new ShareAccessPolicy().setPermissions("r")
.setStartsOn(OffsetDateTime.now(ZoneOffset.UTC))
.setExpiresOn(OffsetDateTime.now(ZoneOffset.UTC).plusDays(10));
ShareSignedIdentifier permission = new ShareSignedIdentifier().setId("mypolicy").setAccessPolicy(accessPolicy);
shareAsyncClient.setAccessPolicyWithResponse(new ShareSetAccessPolicyOptions()
.setPermissions(Collections.singletonList(permission))
.setRequestConditions(new ShareRequestConditions().setLeaseId(leaseId)))
.subscribe(response -> System.out.printf("Setting access policies completed completed with status code %d",
response.getStatusCode()));
For more information, see the Azure Docs.
Parameters:
Returns:
setAccessPolicyWithResponse
public Mono
Sets stored access policies for the share.
Code Samples
Set a read only stored access policy
ShareAccessPolicy accessPolicy = new ShareAccessPolicy().setPermissions("r")
.setStartsOn(OffsetDateTime.now(ZoneOffset.UTC))
.setExpiresOn(OffsetDateTime.now(ZoneOffset.UTC).plusDays(10));
ShareSignedIdentifier permission = new ShareSignedIdentifier().setId("mypolicy").setAccessPolicy(accessPolicy);
shareAsyncClient.setAccessPolicyWithResponse(Collections.singletonList(permission))
.subscribe(response -> System.out.printf("Setting access policies completed completed with status code %d",
response.getStatusCode()));
For more information, see the Azure Docs.
Parameters:
Returns:
setMetadata
public Mono
Sets the user-defined metadata to associate to the share.
If null is passed for the metadata it will clear the metadata associated to the share.
Code Samples
Set the metadata to "share:updatedMetadata"
shareAsyncClient.setMetadata(Collections.singletonMap("share", "updatedMetadata")).doOnSuccess(response ->
System.out.println("Setting the share metadata completed.")
);
Clear the metadata of the share
shareAsyncClient.setMetadata(null).doOnSuccess(response ->
System.out.println("Setting the share metadata completed.")
);
For more information, see the Azure Docs.
Parameters:
Returns:
setMetadataWithResponse
public Mono
Sets the user-defined metadata to associate to the share.
If null is passed for the metadata it will clear the metadata associated to the share.
Code Samples
shareAsyncClient.setMetadataWithResponse(new ShareSetMetadataOptions()
.setMetadata(Collections.singletonMap("share", "updatedMetadata"))
.setRequestConditions(new ShareRequestConditions().setLeaseId(leaseId)))
.subscribe(response ->
System.out.printf("Setting the share metadata completed with status code %d", response.getStatusCode())
);
For more information, see the Azure Docs.
Parameters:
Returns:
setMetadataWithResponse
public Mono
Sets the user-defined metadata to associate to the share.
If null is passed for the metadata it will clear the metadata associated to the share.
Code Samples
Set the metadata to "share:updatedMetadata"
shareAsyncClient.setMetadata(Collections.singletonMap("share", "updatedMetadata")).doOnSuccess(response ->
System.out.println("Setting the share metadata completed.")
);
Clear the metadata of the share
shareAsyncClient.setMetadata(null).doOnSuccess(response ->
System.out.println("Setting the share metadata completed.")
);
For more information, see the Azure Docs.
Parameters:
Returns:
setProperties
public Mono
Sets the share's properties.
Code Samples
shareAsyncClient.setProperties(new ShareSetPropertiesOptions().setAccessTier(ShareAccessTier.HOT)
.setQuotaInGb(2014))
.doOnSuccess(response -> System.out.println("Setting the share access tier completed."));
For more information, see the Azure Docs.
Parameters:
Returns:
setPropertiesWithResponse
public Mono
Sets the share's properties.
Code Samples
shareAsyncClient.setPropertiesWithResponse(new ShareSetPropertiesOptions().setAccessTier(ShareAccessTier.HOT)
.setQuotaInGb(1024).setRequestConditions(new ShareRequestConditions().setLeaseId(leaseId)))
.subscribe(response ->
System.out.printf("Setting the share quota completed with status code %d", response.getStatusCode())
);
For more information, see the Azure Docs.
Parameters:
Returns:
setQuota
@Deprecated
public Mono
Deprecated
Sets the maximum size in GB that the share is allowed to grow.
Code Samples
Set the quota to 1024 GB
shareAsyncClient.setQuota(1024).doOnSuccess(response ->
System.out.println("Setting the share quota completed.")
);
For more information, see the Azure Docs.
For more information on updated max file share size values, see the Azure Docs.
Parameters:
Returns:
setQuotaWithResponse
@Deprecated
public Mono
Deprecated
Sets the maximum size in GB that the share is allowed to grow.
Code Samples
Set the quota to 1024 GB
shareAsyncClient.setQuotaWithResponse(1024)
.subscribe(response ->
System.out.printf("Setting the share quota completed with status code %d", response.getStatusCode())
);
For more information, see the Azure Docs.
For more information on updated max file share size values, see the Azure Docs.
Parameters:
Returns:
