Partager via

CloudFileClient Classe

  • Référence
Paquet:
com.microsoft.azure.storage.file
  • java.lang.Object

public class CloudFileClient extends ServiceClient

Fournit un client pour accéder au service Microsoft Azure File.

Cette classe fournit un point d’accès au service De fichiers. Le client du service encapsule l'URI de base pour le service de fichiers. Il encapsule également les informations d’identification pour accéder au compte de stockage.

Récapitulatif du constructeur

Constructeur Description
CloudFileClient(final URI baseUri, StorageCredentials credentials)

Crée un instance de la classe à l’aide du point de terminaison de service de fichiers et des informations d’identification de compte spécifiés.
CloudFileClient(StorageUri storageUri, StorageCredentials credentials)

Crée un instance de la classe à l’aide du point de terminaison de service de fichiers et des informations d’identification de compte spécifiés.

Résumé de la méthode

Modificateur et type Méthode et description
final FileServiceProperties downloadServiceProperties()

Récupère le actuel FileServiceProperties pour le service de stockage donné. Cela encapsule les configurations CORS.
final FileServiceProperties downloadServiceProperties(FileRequestOptions options, OperationContext opContext)

Récupère le actuel FileServiceProperties pour le service de stockage donné. Cela encapsule les configurations CORS.
FileRequestOptions getDefaultRequestOptions()

Obtient le FileRequestOptions qui est utilisé pour les requêtes associées à ce
CloudFileShare getShareReference(final String shareName)

Obtient un CloudFileShare objet avec le nom spécifié.
CloudFileShare getShareReference(final String shareName, String snapshotID)

Obtient un CloudFileShare objet avec le nom spécifié.
boolean isUsePathStyleUris()

Indique si des URI de style chemin d’accès sont utilisés.
Iterable<CloudFileShare> listShares()

Retourne une collection énumérable de partages pour ce client de service de fichiers.
Iterable<CloudFileShare> listShares(final String prefix)

Retourne une collection énumérable de partages dont le nom commence par le préfixe spécifié pour ce client de service de fichiers.
Iterable<CloudFileShare> listShares(final String prefix, final EnumSet<ShareListingDetails> detailsIncluded, final FileRequestOptions options, final OperationContext opContext)

Retourne une collection énumérable de partages dont le nom commence par le préfixe spécifié pour ce client de service de fichiers, à l’aide des paramètres de détails, des options de demande et du contexte d’opération spécifiés.
ResultSegment<CloudFileShare> listSharesSegmented()

Retourne un segment de résultat d’une collection énumérable de partages pour ce client de service de fichiers.
ResultSegment<CloudFileShare> listSharesSegmented(final String prefix)

Retourne un segment de résultat d’une collection énumérable de partages dont le nom commence par le préfixe spécifié pour ce client de service de fichiers.
ResultSegment<CloudFileShare> listSharesSegmented(final String prefix, final EnumSet<ShareListingDetails> detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final FileRequestOptions options, final OperationContext opContext)

Retourne un segment de résultat d’une collection énumérable de partages dont le nom commence par le préfixe spécifié, à l’aide des options de détails de la description, des options de demande et du contexte d’opération spécifiés.
void setDefaultRequestOptions(FileRequestOptions defaultRequestOptions)

Définit le FileRequestOptions qui est utilisé pour toutes les demandes associées à cet objet.
void uploadServiceProperties(final FileServiceProperties properties)

Charge une nouvelle FileServiceProperties configuration sur le service de stockage donné. Cela encapsule les configurations CORS.
void uploadServiceProperties(final FileServiceProperties properties, FileRequestOptions options, OperationContext opContext)

Charge une nouvelle FileServiceProperties configuration sur le service de stockage donné. Cela encapsule les configurations CORS.

Membres hérités

ServiceClient.credentials ServiceClient.downloadServicePropertiesImpl(final RequestOptions options, final boolean signAsTable) ServiceClient.getCredentials() ServiceClient.getEndpoint() ServiceClient.getServiceStatsImpl(final RequestOptions options, final boolean signAsTable) ServiceClient.getStorageUri() ServiceClient.ServiceClient(final StorageUri storageUri, final StorageCredentials credentials) ServiceClient.setCredentials(final StorageCredentials credentials) ServiceClient.setStorageUri(final StorageUri storageUri) ServiceClient.uploadServicePropertiesImpl(final ServiceProperties properties, final RequestOptions options, final OperationContext opContext, final boolean signAsTable)

Détails du constructeur

CloudFileClient

public CloudFileClient(final URI baseUri, StorageCredentials credentials)

Crée un instance de la classe à l’aide du point de terminaison de service de fichiers et des informations d’identification de compte spécifiés.

Parameters:

baseUri - Objet java.net.URI qui représente le point de terminaison du service de fichiers utilisé pour créer le client.
credentials - Objet StorageCredentials qui représente les informations d’identification du compte.

CloudFileClient

public CloudFileClient(StorageUri storageUri, StorageCredentials credentials)

Crée un instance de la classe à l’aide du point de terminaison de service de fichiers et des informations d’identification de compte spécifiés.

Parameters:

storageUri - Objet StorageUri qui représente le point de terminaison du service de fichiers utilisé pour créer le client.
credentials - Objet StorageCredentials qui représente les informations d’identification du compte.

Détails de la méthode

downloadServiceProperties

public final FileServiceProperties downloadServiceProperties()

Récupère le actuel FileServiceProperties pour le service de stockage donné. Cela encapsule les configurations CORS.

Returns:

Objet FileServiceProperties représentant la configuration actuelle du service.

Throws:

StorageException - Si une erreur de service de stockage s’est produite.

downloadServiceProperties

public final FileServiceProperties downloadServiceProperties(FileRequestOptions options, OperationContext opContext)

Récupère le actuel FileServiceProperties pour le service de stockage donné. Cela encapsule les configurations CORS.

Parameters:

options - Objet FileRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null utilise les options de requête par défaut du client de service associé (CloudFileClient).
opContext - Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.

Returns:

Objet FileServiceProperties représentant la configuration actuelle du service.

Throws:

StorageException - Si une erreur de service de stockage s’est produite.

getDefaultRequestOptions

public FileRequestOptions getDefaultRequestOptions()

Obtient le FileRequestOptions qui est utilisé pour les requêtes associées à ce

Returns:

Objet FileRequestOptions contenant les valeurs utilisées par ce CloudFileClient

getShareReference

public CloudFileShare getShareReference(final String shareName)

Obtient un CloudFileShare objet avec le nom spécifié.

Parameters:

shareName - Nom du partage, qui doit respecter les règles de nommage du 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 (-).

Returns:

Référence à un objet CloudFileShare.

Throws:

StorageException
URISyntaxException

getShareReference

public CloudFileShare getShareReference(final String shareName, String snapshotID)

Obtient un CloudFileShare objet avec le nom spécifié.

Parameters:

shareName - Nom du partage, qui doit respecter les règles de nommage du 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 (-).
snapshotID - String qui représente l’ID instantané du partage.

Returns:

Référence à un objet CloudFileShare.

Throws:

StorageException
URISyntaxException

isUsePathStyleUris

protected boolean isUsePathStyleUris()

Indique si des URI de style chemin d’accès sont utilisés.

Returns:

true si vous utilisez des URI de style chemin d’accès ; sinon, false.

listShares

public Iterable listShares()

Retourne une collection énumérable de partages pour ce client de service de fichiers.

Returns:

Collection énumérable d’objets CloudFileShare récupérés tardivement qui représentent les partages de ce client.

listShares

public Iterable listShares(final String prefix)

Retourne une collection énumérable de partages dont le nom commence par le préfixe spécifié pour ce client de service de fichiers.

Parameters:

prefix - String qui représente le préfixe de nom de partage.

Returns:

Collection énumérable d’objets CloudFileShare récupérés tardivement qui représentent les partages de ce client dont les noms commencent par le préfixe spécifié.

listShares

public Iterable listShares(final String prefix, final EnumSet detailsIncluded, final FileRequestOptions options, final OperationContext opContext)

Retourne une collection énumérable de partages dont le nom commence par le préfixe spécifié pour ce client de service de fichiers, à l’aide des paramètres de détails, des options de demande et du contexte d’opération spécifiés.

Parameters:

prefix - String qui représente le préfixe de nom de partage.
detailsIncluded - Objet java.util.EnumSet qui contient des ShareListingDetails valeurs qui indiquent si des instantanés de partage et/ou des métadonnées seront retournés.
options - Objet FileRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null utilise les options de requête par défaut du client de service associé ( CloudFileClient).
opContext - Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.

Returns:

Collection énumérable d’objets CloudFileShare récupérés tardivement qui représente les partages de ce client.

listSharesSegmented

public ResultSegment listSharesSegmented()

Retourne un segment de résultat d’une collection énumérable de partages pour ce client de service de fichiers.

Returns:

Objet ResultSegment<T> qui contient un segment de la collection énumérable d’objets CloudFileShare qui représentent les partages pour ce client.

Throws:

StorageException - Si une erreur de service de stockage s’est produite.

listSharesSegmented

public ResultSegment listSharesSegmented(final String prefix)

Retourne un segment de résultat d’une collection énumérable de partages dont le nom commence par le préfixe spécifié pour ce client de service de fichiers.

Parameters:

prefix - String qui représente le préfixe du nom du partage.

Returns:

Objet ResultSegment<T> qui contient un segment de la collection énumérable d’objets CloudFileShare qui représentent les partages dont le nom commence par le préfixe spécifié.

Throws:

StorageException - Si une erreur de service de stockage s’est produite.

listSharesSegmented

public ResultSegment listSharesSegmented(final String prefix, final EnumSet detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final FileRequestOptions options, final OperationContext opContext)

Retourne un segment de résultat d’une collection énumérable de partages dont le nom commence par le préfixe spécifié, à l’aide des options de détails de la description, des options de demande et du contexte d’opération spécifiés.

Parameters:

prefix - String qui représente le préfixe du nom du partage.
detailsIncluded - Objet java.util.EnumSet qui contient des ShareListingDetails valeurs qui indiquent si des instantanés de partage et/ou des métadonnées seront retournés.
maxResults - Nombre maximal de résultats à récupérer. Si null ou supérieur à 5 000, le serveur retourne jusqu’à 5 000 éléments. Doit être au moins égal à 1.
continuationToken - Objet ResultContinuation qui représente un jeton de continuation retourné par une opération de référencement précédente.
options - Objet FileRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null utilise les options de requête par défaut du client de service associé ( CloudFileClient).
opContext - Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.

Returns:

Objet ResultSegment<T> qui contient un segment de la collection énumérable d’objets CloudFileShare qui représentent les partages pour ce client.

Throws:

StorageException - Si une erreur de service de stockage s’est produite.

setDefaultRequestOptions

public void setDefaultRequestOptions(FileRequestOptions defaultRequestOptions)

Définit le FileRequestOptions qui est utilisé pour toutes les demandes associées à cet objet.

Parameters:

defaultRequestOptions - Objet FileRequestOptions qui spécifie les options à utiliser.

uploadServiceProperties

public void uploadServiceProperties(final FileServiceProperties properties)

Charge une nouvelle FileServiceProperties configuration sur le service de stockage donné. Cela encapsule les configurations CORS.

Parameters:

properties - Objet FileServiceProperties qui spécifie les propriétés de service à charger.

Throws:

StorageException - Si une erreur de service de stockage s’est produite.

uploadServiceProperties

public void uploadServiceProperties(final FileServiceProperties properties, FileRequestOptions options, OperationContext opContext)

Charge une nouvelle FileServiceProperties configuration sur le service de stockage donné. Cela encapsule les configurations CORS.

Parameters:

properties - Objet FileServiceProperties qui spécifie les propriétés de service à charger.
options - Objet FileRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null utilise les options de requête par défaut du client de service associé (CloudFileClient).
opContext - Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.

Throws:

StorageException - Si une erreur de service de stockage s’est produite.

S’applique à