CloudFileShare Classe
- java.
lang. Object - com.
microsoft. azure. storage. file. CloudFileShare
- com.
public class CloudFileShare
Représente un partage dans le service Microsoft Azure File.
Les partages contiennent des répertoires, qui sont encapsulés sous forme CloudFileDirectory d’objets, et les répertoires contiennent des fichiers. Les répertoires peuvent aussi contenir des sous-répertoires.
Récapitulatif du constructeur
Constructeur | Description |
---|---|
CloudFileShare(final StorageUri storageUri) |
Crée un instance de la classe à l’aide de l’URI spécifié. |
CloudFileShare(final StorageUri storageUri, final StorageCredentials credentials) |
Crée un instance de la classe à l’aide des informations d’identification storageUri et spécifiées. |
CloudFileShare(final String shareName, String snapshotID, final CloudFileClient client) |
Crée une instance de la classe à l’aide du nom et du client spécifiés. |
CloudFileShare(final URI uri) |
Crée un instance de la classe à l’aide de l’URI spécifié. |
CloudFileShare(final URI uri, final StorageCredentials credentials) |
Crée une instance de la classe à l’aide de l’URI et des informations d’identification spécifiées. |
Résumé de la méthode
Modificateur et type | Méthode et description |
---|---|
void |
assertNoSnapshot()
Affirme que le partage n’est pas un instantané. |
void |
create()
Crée le partage. |
void |
create(FileRequestOptions options, OperationContext opContext)
Crée le partage à l’aide des options et du contexte d’opération spécifiés. |
String |
createFilePermission(String permission)
Crée une autorisation de fichier. |
String |
createFilePermission(String permission, FileRequestOptions options, OperationContext opContext)
Crée une autorisation de fichier. |
boolean |
createIfNotExists()
Crée le partage s’il n’existe pas. |
boolean |
createIfNotExists(FileRequestOptions options, OperationContext opContext)
Crée le partage s’il n’existe pas, à l’aide des options de requête et du contexte d’opération spécifiés. |
final Cloud |
createSnapshot()
Crée une instantané du partage. |
final Cloud |
createSnapshot(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Crée une instantané du partage de fichiers à l’aide des options de requête et du contexte d’opération spécifiés. |
final Cloud |
createSnapshot(final HashMap<String, String> metadata, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Crée une instantané du partage de fichiers à l’aide des options de requête et du contexte d’opération spécifiés. |
void |
delete()
Supprime le partage. |
void |
delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Supprime le partage à l’aide des options de requête et du contexte d’opération spécifiés. |
void |
delete(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Supprime le partage à l’aide des options de instantané et de requête spécifiées, ainsi que du contexte d’opération. Un partage contenant des instantanés ne peut pas être supprimé, sauf si les instantanés sont également supprimés. Si un partage a des instantanés, utilisez la INCLUDE_SNAPSHOTS valeur dans le paramètre pour inclure les instantanés lors de la suppression du partage de base. |
boolean |
deleteIfExists()
Supprime le partage s’il existe. |
boolean |
deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Supprime le partage s’il existe à l’aide des options de requête et du contexte d’opération spécifiés. |
boolean |
deleteIfExists(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Supprime le partage s’il existe, à l’aide des options de instantané et de requête spécifiées, ainsi que du contexte d’opération. Un partage contenant des instantanés ne peut pas être supprimé, sauf si les instantanés sont également supprimés. Si un partage a des instantanés, utilisez la INCLUDE_SNAPSHOTS valeur dans le paramètre pour inclure les instantanés lors de la suppression du partage de base. |
void |
downloadAttributes()
Télécharge les attributs du partage, qui se composent de métadonnées et de propriétés. |
void |
downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Télécharge les attributs du partage, qui se composent de métadonnées et de propriétés, à l’aide des options de requête et du contexte d’opération spécifiés. |
File |
downloadPermissions()
Télécharge les paramètres d’autorisation pour le partage. |
File |
downloadPermissions(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Télécharge les paramètres d’autorisations pour le partage à l’aide des options de requête et du contexte d’opération spécifiés. |
boolean |
exists()
Retourne une valeur qui indique si le partage existe. |
boolean |
exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Retourne une valeur qui indique si le partage existe, à l’aide des options de requête et du contexte d’opération spécifiés. |
String |
generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier)
Retourne une signature d’accès partagé pour le partage. Notez qu’il ne contient pas le premier « ? ». |
String |
generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)
Retourne une signature d’accès partagé pour le partage. Notez qu’il ne contient pas le premier « ? ». |
String |
getFilePermission(String filePermissionKey)
Obtient l’autorisation de fichier associée à une clé d’autorisation de fichier. |
String |
getFilePermission(String filePermissionKey, FileRequestOptions options, OperationContext opContext)
Obtient l’autorisation de fichier associée à une clé d’autorisation de fichier. |
HashMap<String, String> |
getMetadata()
Retourne les métadonnées du partage. Cette valeur est initialisée avec les métadonnées du partage par un appel à downloadAttributes(), et est définie sur le partage avec un appel sur uploadMetadata(). |
String |
getName()
Retourne le nom du partage. |
File |
getProperties()
Retourne les propriétés du partage. |
final URI |
getQualifiedUri()
Retourne l’URI qualifié instantané ou de signature d’accès partagé pour ce partage. |
Cloud |
getRootDirectoryReference()
Retourne une référence à un CloudFileDirectory objet qui représente le répertoire de fichiers racine au sein de ce partage. |
Cloud |
getServiceClient()
Retourne le client de service de fichiers associé à ce partage. |
final String |
getSnapshot()
Retourne l’ID d’instantané pour ce partage. |
Share |
getStats()
Interroge le service pour le partage de ShareStats. |
Share |
getStats(FileRequestOptions options, OperationContext opContext)
Interroge le service pour le partage de ShareStats. |
Storage |
getStorageUri()
Retourne la liste des URI pour tous les emplacements. |
URI |
getUri()
Retourne l’URI de ce partage. |
final boolean |
isSnapshot()
Indique si ce partage est un instantané. |
void |
setMetadata(final HashMap<String, String> metadata)
Définit la collection de métadonnées des paires nom-valeur à définir sur le partage avec un uploadMetadata() appel. Cette collection remplace toutes les métadonnées de partage existantes. Si cette valeur est définie sur une collection vide, les métadonnées de partage sont effacées lors d’un uploadMetadata() appel. |
void |
setProperties(final FileShareProperties properties)
Définit les propriétés du partage. |
void |
uploadMetadata()
Charge les métadonnées du partage. |
void |
uploadMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Charge les métadonnées du partage à l’aide des options de requête et du contexte d’opération spécifiés. |
void |
uploadPermissions(final FileSharePermissions permissions)
Charge les autorisations du partage. |
void |
uploadPermissions(final FileSharePermissions permissions, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Charge les autorisations du partage à l’aide des options de requête et du contexte d’opération spécifiés. |
final void |
uploadProperties()
Mises à jour les propriétés du partage sur le service de stockage. Utilisez downloadAttributes() pour récupérer les dernières valeurs des propriétés et métadonnées du partage à partir du service de stockage Microsoft Azure. |
final void |
uploadProperties(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Mises à jour les propriétés du partage à l’aide des options de requête et du contexte d’opération. Utilisez downloadAttributes() pour récupérer les dernières valeurs des propriétés et métadonnées du partage à partir du service de stockage Microsoft Azure. |
Détails du constructeur
CloudFileShare
public CloudFileShare(final StorageUri storageUri)
Crée un instance de la classe à l’aide de l’URI spécifié.
Parameters:
Throws:
CloudFileShare
public CloudFileShare(final StorageUri storageUri, final StorageCredentials credentials)
Crée un instance de la classe à l’aide des informations d’identification storageUri et spécifiées.
Parameters:
Throws:
CloudFileShare
public CloudFileShare(final String shareName, String snapshotID, final CloudFileClient client)
Crée une instance de la classe à l’aide du nom et du client spécifiés.
Parameters:
String
qui représente le nom du partage, qui doit respecter les règles de nommage de partage. Le nom du partage ne doit pas inclure de caractères séparateurs de chemin d’accès (/). Les noms de partage doivent être en minuscules, entre 3 et 63 caractères et doivent commencer par une lettre ou un nombre. Les noms de partage peuvent contenir uniquement des lettres, des chiffres et le tiret (-).
String
qui représente la version instantané, le cas échéant.
Throws:
CloudFileShare
public CloudFileShare(final URI uri)
Crée un instance de la classe à l’aide de l’URI spécifié.
Parameters:
java.net.URI
qui représente l’URI absolu du partage.
Throws:
CloudFileShare
public CloudFileShare(final URI uri, final StorageCredentials credentials)
Crée une instance de la classe à l’aide de l’URI et des informations d’identification spécifiées.
Parameters:
java.net.URI
qui représente l’URI absolu du partage.
Throws:
Détails de la méthode
assertNoSnapshot
protected void assertNoSnapshot()
Affirme que le partage n’est pas un instantané.
create
public void create()
Crée le partage.
Throws:
create
public void create(FileRequestOptions options, OperationContext opContext)
Crée le partage à l’aide des options et du contexte d’opération spécifiés.
Parameters:
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Throws:
createFilePermission
public String createFilePermission(String permission)
Crée une autorisation de fichier.
Parameters:
String
qui représente l’autorisation de fichier à créer.
Returns:
String
représentant la clé d’autorisation de fichier associée à l’autorisation de fichier créée.Throws:
createFilePermission
public String createFilePermission(String permission, FileRequestOptions options, OperationContext opContext)
Crée une autorisation de fichier.
Parameters:
String
qui représente l’autorisation de fichier à créer.
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Returns:
String
représentant la clé d’autorisation de fichier associée à l’autorisation de fichier créée.Throws:
createIfNotExists
public boolean createIfNotExists()
Crée le partage s’il n’existe pas.
Returns:
true
si le partage n'existait pas et a été créé ; sinon false
.
Throws:
createIfNotExists
public boolean createIfNotExists(FileRequestOptions options, OperationContext opContext)
Crée le partage s’il n’existe pas, à l’aide des options de requête et du contexte d’opération spécifiés.
Parameters:
null
utilise les options de requête par défaut du client de service associé (CloudFileClient).
Returns:
true
si le partage n'existait pas et a été créé ; sinon false
.
Throws:
createSnapshot
public final CloudFileShare createSnapshot()
Crée une instantané du partage.
Returns:
CloudFileShare
qui représente le instantané du partage.Throws:
createSnapshot
public final CloudFileShare createSnapshot(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Crée une instantané du partage de fichiers à l’aide des options de requête et du contexte d’opération spécifiés.
Parameters:
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Returns:
CloudFileShare
qui représente le instantané du partage de fichiers.Throws:
createSnapshot
public final CloudFileShare createSnapshot(final HashMap
Crée une instantané du partage de fichiers à l’aide des options de requête et du contexte d’opération spécifiés.
Parameters:
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Returns:
CloudFileShare
qui représente le instantané du partage de fichiers.Throws:
delete
public void delete()
Supprime le partage.
Throws:
delete
public void delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Supprime le partage à l’aide des options de requête et du contexte d’opération spécifiés.
Parameters:
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Throws:
delete
public void delete(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Supprime le partage à l’aide des options de instantané et de requête spécifiées, ainsi que du contexte d’opération.
Un partage contenant des instantanés ne peut pas être supprimé, sauf si les instantanés sont également supprimés. Si un partage a des instantanés, utilisez la INCLUDE_SNAPSHOTS valeur dans le paramètre pour inclure les instantanés lors de la suppression du partage de base.
Parameters:
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Throws:
deleteIfExists
public boolean deleteIfExists()
Supprime le partage s’il existe.
Returns:
true
si le partage existait et a été supprimé ; sinon, false
.
Throws:
deleteIfExists
public boolean deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Supprime le partage s’il existe à l’aide des options de requête et du contexte d’opération spécifiés.
Parameters:
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Returns:
true
si le partage existait et a été supprimé ; sinon, false
.
Throws:
deleteIfExists
public boolean deleteIfExists(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Supprime le partage s’il existe, à l’aide des options de instantané et de requête spécifiées, ainsi que du contexte d’opération.
Un partage contenant des instantanés ne peut pas être supprimé, sauf si les instantanés sont également supprimés. Si un partage a des instantanés, utilisez la INCLUDE_SNAPSHOTS valeur dans le paramètre pour inclure les instantanés lors de la suppression du partage de base.
Parameters:
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Returns:
true
si le partage existait et a été supprimé ; sinon, false
.
Throws:
downloadAttributes
public void downloadAttributes()
Télécharge les attributs du partage, qui se composent de métadonnées et de propriétés.
Throws:
downloadAttributes
public void downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Télécharge les attributs du partage, qui se composent de métadonnées et de propriétés, à l’aide des options de requête et du contexte d’opération spécifiés.
Parameters:
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Throws:
downloadPermissions
public FileSharePermissions downloadPermissions()
Télécharge les paramètres d’autorisation pour le partage.
Returns:
Throws:
downloadPermissions
public FileSharePermissions downloadPermissions(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Télécharge les paramètres d’autorisations pour le partage à l’aide des options de requête et du contexte d’opération spécifiés.
Parameters:
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Returns:
Throws:
exists
public boolean exists()
Retourne une valeur qui indique si le partage existe.
Returns:
true
si le partage existe, sinon false
.
Throws:
exists
public boolean exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Retourne une valeur qui indique si le partage existe, à l’aide des options de requête et du contexte d’opération spécifiés.
Parameters:
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Returns:
true
si le partage existe, sinon false
.
Throws:
generateSharedAccessSignature
public String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier)
Retourne une signature d’accès partagé pour le partage. Notez qu’il ne contient pas le premier « ? ».
Parameters:
String
au niveau du partage.
Returns:
String
qui représente une signature d’accès partagé pour le partage.Throws:
generateSharedAccessSignature
public String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)
Retourne une signature d’accès partagé pour le partage. Notez qu’il ne contient pas le premier « ? ».
Parameters:
String
au niveau du partage.
Returns:
String
qui représente une signature d’accès partagé pour le partage.Throws:
getFilePermission
public String getFilePermission(String filePermissionKey)
Obtient l’autorisation de fichier associée à une clé d’autorisation de fichier.
Parameters:
String
qui représente la clé d’autorisation de fichier.
Returns:
String
représentant l’autorisation de fichier associée à la clé d’autorisation de fichier.Throws:
getFilePermission
public String getFilePermission(String filePermissionKey, FileRequestOptions options, OperationContext opContext)
Obtient l’autorisation de fichier associée à une clé d’autorisation de fichier.
Parameters:
String
qui représente la clé d’autorisation de fichier.
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Returns:
String
représentant l’autorisation de fichier associée à la clé d’autorisation de fichier.Throws:
getMetadata
public HashMap
Retourne les métadonnées du partage. Cette valeur est initialisée avec les métadonnées du partage par un appel à downloadAttributes(), et est définie sur le partage avec un appel sur uploadMetadata().
Returns:
java.util.HashMap
qui représente les métadonnées du partage.getName
public String getName()
Retourne le nom du partage.
Returns:
String
qui représente le nom du partage.getProperties
public FileShareProperties getProperties()
Retourne les propriétés du partage.
Returns:
getQualifiedUri
public final URI getQualifiedUri()
Retourne l’URI qualifié instantané ou de signature d’accès partagé pour ce partage.
Returns:
java.net.URI
qui représente le instantané ou la signature d’accès partagé.Throws:
getRootDirectoryReference
public CloudFileDirectory getRootDirectoryReference()
Retourne une référence à un CloudFileDirectory objet qui représente le répertoire de fichiers racine au sein de ce partage.
Returns:
Throws:
getServiceClient
public CloudFileClient getServiceClient()
Retourne le client de service de fichiers associé à ce partage.
Returns:
getSnapshot
public final String getSnapshot()
Retourne l’ID d’instantané pour ce partage.
Returns:
getStats
public ShareStats getStats()
Interroge le service pour le partage de ShareStats.
Returns:
Throws:
getStats
public ShareStats getStats(FileRequestOptions options, OperationContext opContext)
Interroge le service pour le partage de ShareStats.
Parameters:
null
utilise les options de requête par défaut du client de service associé (CloudFileClient).
Returns:
Throws:
getStorageUri
public StorageUri getStorageUri()
Retourne la liste des URI pour tous les emplacements.
Returns:
getUri
public URI getUri()
Retourne l’URI de ce partage.
Returns:
isSnapshot
public final boolean isSnapshot()
Indique si ce partage est un instantané.
Returns:
true
si le partage est un instantané, sinon false
.
setMetadata
public void setMetadata(final HashMap
Définit la collection de métadonnées des paires nom-valeur à définir sur le partage avec un uploadMetadata() appel. Cette collection remplace toutes les métadonnées de partage existantes. Si cette valeur est définie sur une collection vide, les métadonnées de partage sont effacées lors d’un uploadMetadata() appel.
Parameters:
java.util.HashMap
qui représente les métadonnées affectées au partage.
setProperties
public void setProperties(final FileShareProperties properties)
Définit les propriétés du partage.
Parameters:
uploadMetadata
public void uploadMetadata()
Charge les métadonnées du partage.
Throws:
uploadMetadata
public void uploadMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Charge les métadonnées du partage à l’aide des options de requête et du contexte d’opération spécifiés.
Parameters:
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Throws:
uploadPermissions
public void uploadPermissions(final FileSharePermissions permissions)
Charge les autorisations du partage.
Parameters:
Throws:
uploadPermissions
public void uploadPermissions(final FileSharePermissions permissions, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Charge les autorisations du partage à l’aide des options de requête et du contexte d’opération spécifiés.
Parameters:
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Throws:
uploadProperties
public final void uploadProperties()
Mises à jour les propriétés du partage sur le service de stockage.
Utilisez downloadAttributes() pour récupérer les dernières valeurs des propriétés et métadonnées du partage à partir du service de stockage Microsoft Azure.
Throws:
uploadProperties
public final void uploadProperties(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Mises à jour les propriétés du partage à l’aide des options de requête et du contexte d’opération.
Utilisez downloadAttributes() pour récupérer les dernières valeurs des propriétés et métadonnées du partage à partir du service de stockage Microsoft Azure.
Parameters:
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Throws:
S’applique à
Azure SDK for Java