Partager via

CloudBlobClient Classe

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

public class CloudBlobClient extends ServiceClient

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

Cette classe fournit un point d’accès au service Blob. Le client du service encapsule l'URI de base pour le service BLOB. Si le client du service est utilisé pour l'accès authentifié, il encapsule aussi les informations d'identification pour accéder au compte de stockage.

Récapitulatif du constructeur

Constructeur Description
CloudBlobClient(final StorageUri baseUri)

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

Crée un instance de la classe à l’aide du point de terminaison de service Blob et des informations d’identification de compte spécifiés.
CloudBlobClient(final URI baseUri)

Crée un instance de la classe à l’aide du point de terminaison de service Blob et des informations d’identification anonymes spécifiés.
CloudBlobClient(final URI baseUri, StorageCredentials credentials)

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

Résumé de la méthode

Modificateur et type Méthode et description
AccountInformation downloadAccountInfo()

Obtient des informations relatives au compte de stockage.
AccountInformation downloadAccountInfo(BlobRequestOptions options, OperationContext opContext)

Obtient des informations relatives au compte de stockage.
StorageRequest<ServiceClient, Void, AccountInformation> downloadAccountInformationImpl(final RequestOptions options)
final ServiceProperties downloadServiceProperties()

Récupère le actuel ServiceProperties pour le service de stockage donné. Cela inclut les configurations Logging, HourMetrics, MinuteMetrics et CORS.
final ServiceProperties downloadServiceProperties(BlobRequestOptions options, OperationContext opContext)

Récupère le actuel ServiceProperties pour le service de stockage donné. Cela inclut les configurations Logging, HourMetrics, MinuteMetrics et CORS.
<P, T> Map<P, T> executeBatch(BlobBatchOperation<P, T> batch)

Exécute une opération de traitement par lots prédéfinie sur le service blob. Pour plus d’informations sur la construction de requêtes par lots d’objets blob, consultez BlobBatchOperation<P,R>.
<P, T> Map<P, T> executeBatch(BlobBatchOperation<P, T> batch, BlobRequestOptions requestOptions, OperationContext operationContext)

Exécute une opération de traitement par lots prédéfinie sur le service blob. Pour plus d’informations sur la construction de requêtes par lots d’objets blob, consultez BlobBatchOperation<P,R>.
CloudBlobContainer getContainerReference(final String containerName)

Obtient un CloudBlobContainer objet avec le nom spécifié.
BlobRequestOptions getDefaultRequestOptions()

Obtient le BlobRequestOptions qui est utilisé pour les requêtes associées à ce
String getDirectoryDelimiter()

Retourne la valeur du délimiteur par défaut utilisé pour les répertoires d’objets blob cloud. La valeur par défaut est « / ».
ServiceStats getServiceStats()

Interroge le service pour le ServiceStats.
ServiceStats getServiceStats(BlobRequestOptions options, OperationContext opContext)

Interroge le service de stockage donné pour .ServiceStats
UserDelegationKey getUserDelegationKey(Date keyStart, Date keyEnd)

Demande une nouvelle clé de délégation utilisateur basée sur les informations d’identification oauth de ce client.

UserDelegationKey getUserDelegationKey(Date keyStart, Date keyEnd, BlobRequestOptions options, OperationContext opContext)

Demande une nouvelle clé de délégation utilisateur basée sur les informations d’identification oauth de ce client.

boolean isUsePathStyleUris()

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

Retourne une collection énumérable de conteneurs d’objets blob pour ce client de service Blob.
Iterable<CloudBlobContainer> listContainers(final String prefix)

Retourne une collection énumérable de conteneurs d’objets blob dont le nom commence par le préfixe spécifié pour ce client de service Blob.
Iterable<CloudBlobContainer> listContainers(final String prefix, final ContainerListingDetails detailsIncluded, final BlobRequestOptions options, final OperationContext opContext)

Retourne une collection énumérable de conteneurs d’objets blob dont les noms commencent par le préfixe spécifié pour ce client de service Blob, à l’aide du paramètre de détails, des options de demande et du contexte d’opération spécifiés.
ResultSegment<CloudBlobContainer> listContainersSegmented()

Retourne un segment de résultat d’une collection énumérable de conteneurs d’objets blob pour ce client de service Blob.
ResultSegment<CloudBlobContainer> listContainersSegmented(final String prefix)

Retourne un segment de résultat d’une collection énumérable de conteneurs d’objets blob dont les noms commencent par le préfixe spécifié pour ce client de service Blob.
ResultSegment<CloudBlobContainer> listContainersSegmented(final String prefix, final ContainerListingDetails detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final BlobRequestOptions options, final OperationContext opContext)

Retourne un segment de résultat d’une collection énumérable de conteneurs d’objets blob dont les noms commencent par le préfixe spécifié pour ce client de service Blob, à l’aide des options de détails de liste, des options de demande et du contexte d’opération spécifiés.
void setDefaultRequestOptions(BlobRequestOptions defaultRequestOptions)

Définit le BlobRequestOptions qui est utilisé pour toutes les demandes associées à cet objet.
void setDirectoryDelimiter(final String directoryDelimiter)

Définit la valeur du délimiteur par défaut utilisé pour les répertoires d’objets blob cloud.
void uploadServiceProperties(final ServiceProperties properties)

Charge une nouvelle ServiceProperties configuration sur le service de stockage donné. Cela inclut les configurations Logging, HourMetrics, MinuteMetrics et CORS.
void uploadServiceProperties(final ServiceProperties properties, BlobRequestOptions options, OperationContext opContext)

Charge une nouvelle ServiceProperties configuration sur le service de stockage donné. Cela inclut les configurations Logging, HourMetrics, MinuteMetrics et 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

CloudBlobClient

public CloudBlobClient(final StorageUri baseUri)

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

Parameters:

baseUri - Objet StorageUri qui représente le point de terminaison du service Blob utilisé pour créer le client.

CloudBlobClient

public CloudBlobClient(final StorageUri storageUri, StorageCredentials credentials)

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

Parameters:

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

CloudBlobClient

public CloudBlobClient(final URI baseUri)

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

Parameters:

baseUri - Objet java.net.URI qui représente le point de terminaison du service Blob utilisé pour créer le client.

CloudBlobClient

public CloudBlobClient(final URI baseUri, StorageCredentials credentials)

Crée un instance de la classe à l’aide du point de terminaison de service Blob 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 Blob utilisé pour créer le client.
credentials - Objet StorageCredentials qui représente les informations d’identification du compte.

Détails de la méthode

downloadAccountInfo

public AccountInformation downloadAccountInfo()

Obtient des informations relatives au compte de stockage.

Returns:

Objet AccountInformation pour le compte de stockage donné.

Throws:

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

downloadAccountInfo

public AccountInformation downloadAccountInfo(BlobRequestOptions options, OperationContext opContext)

Obtient des informations relatives au compte de stockage.

Parameters:

options - Objet BlobRequestOptions 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é ( CloudBlobClient).
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 AccountInformation pour le compte de stockage donné.

Throws:

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

downloadAccountInformationImpl

protected StorageRequest downloadAccountInformationImpl(final RequestOptions options)

Parameters:

options

downloadServiceProperties

public final ServiceProperties downloadServiceProperties()

Récupère le actuel ServiceProperties pour le service de stockage donné. Cela inclut les configurations Logging, HourMetrics, MinuteMetrics et CORS.

Returns:

Objet ServiceProperties représentant la configuration actuelle du service.

Throws:

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

downloadServiceProperties

public final ServiceProperties downloadServiceProperties(BlobRequestOptions options, OperationContext opContext)

Récupère le actuel ServiceProperties pour le service de stockage donné. Cela inclut les configurations Logging, HourMetrics, MinuteMetrics et CORS.

Parameters:

options - Objet BlobRequestOptions 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é ( CloudBlobClient).
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 ServiceProperties représentant la configuration actuelle du service.

Throws:

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

executeBatch

public Map executeBatch(BlobBatchOperation batch)

Exécute une opération de traitement par lots prédéfinie sur le service blob. Pour plus d’informations sur la construction de requêtes par lots d’objets blob, consultez BlobBatchOperation<P,R>.

Parameters:

batch - Lot d’opérations à exécuter.

Returns:

Mappage de l’objet parent dans le lot à la réponse de ce parent.

Throws:

BatchException - Lève ce sous-ensemble d’exception de stockage si une ou plusieurs demandes individuelles sur le lot échouent.
StorageException - Lève si une erreur se produit avec le service.

executeBatch

public Map executeBatch(BlobBatchOperation batch, BlobRequestOptions requestOptions, OperationContext operationContext)

Exécute une opération de traitement par lots prédéfinie sur le service blob. Pour plus d’informations sur la construction de requêtes par lots d’objets blob, consultez BlobBatchOperation<P,R>.

Parameters:

batch - Lot d’opérations à exécuter.
requestOptions - Objet BlobRequestOptions 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é ( CloudBlobClient).
operationContext - 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:

Mappage de l’objet parent dans le lot à la réponse de ce parent.

Throws:

BatchException - Lève ce sous-ensemble d’exception de stockage si une ou plusieurs demandes individuelles sur le lot échouent.
StorageException - Lève si une erreur se produit avec le service.

getContainerReference

public CloudBlobContainer getContainerReference(final String containerName)

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

Parameters:

containerName - Nom du conteneur, qui doit respecter les règles de nommage du conteneur. Le nom du conteneur ne doit pas inclure de caractères séparateurs de chemin d’accès (/). Les noms de conteneur doivent être en minuscules, entre 3 et 63 caractères et doivent commencer par une lettre ou un nombre. Les noms de conteneur peuvent contenir uniquement des lettres, des chiffres et le tiret (-).

Returns:

Référence à un objet CloudBlobContainer.

Throws:

URISyntaxException - Si l’URI de ressource construit en fonction du containerName n’est pas valide.
StorageException - Si une erreur de service de stockage s’est produite.

getDefaultRequestOptions

public BlobRequestOptions getDefaultRequestOptions()

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

Returns:

Objet BlobRequestOptions contenant les valeurs utilisées par ce CloudBlobClient

getDirectoryDelimiter

public String getDirectoryDelimiter()

Retourne la valeur du délimiteur par défaut utilisé pour les répertoires d’objets blob cloud. La valeur par défaut est « / ».

Returns:

String qui représente la valeur du délimiteur par défaut.

getServiceStats

public ServiceStats getServiceStats()

Interroge le service pour le ServiceStats.

Returns:

Objet ServiceStats pour le service de stockage donné.

Throws:

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

getServiceStats

public ServiceStats getServiceStats(BlobRequestOptions options, OperationContext opContext)

Interroge le service de stockage donné pour .ServiceStats

Parameters:

options - Objet BlobRequestOptions 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é ( CloudBlobClient).
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 ServiceStats pour le service de stockage donné.

Throws:

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

getUserDelegationKey

public UserDelegationKey getUserDelegationKey(Date keyStart, Date keyEnd)

Demande une nouvelle clé de délégation utilisateur basée sur les informations d’identification oauth de ce client.

Parameters:

keyStart - Heure de début de la validité de la clé demandée.
keyEnd - Heure de fin de la validité de la clé demandée.

Returns:

Clé demandée.

Throws:

StorageException

getUserDelegationKey

public UserDelegationKey getUserDelegationKey(Date keyStart, Date keyEnd, BlobRequestOptions options, OperationContext opContext)

Demande une nouvelle clé de délégation utilisateur basée sur les informations d’identification oauth de ce client.

Parameters:

keyStart - Heure de début de la validité de la clé demandée.
keyEnd - Heure de fin de la validité de la clé demandée.
options - Objet BlobRequestOptions 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é ( CloudBlobClient).
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:

Clé demandée.

Throws:

StorageException

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.

listContainers

public Iterable listContainers()

Retourne une collection énumérable de conteneurs d’objets blob pour ce client de service Blob.

Returns:

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

listContainers

public Iterable listContainers(final String prefix)

Retourne une collection énumérable de conteneurs d’objets blob dont le nom commence par le préfixe spécifié pour ce client de service Blob.

Parameters:

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

Returns:

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

listContainers

public Iterable listContainers(final String prefix, final ContainerListingDetails detailsIncluded, final BlobRequestOptions options, final OperationContext opContext)

Retourne une collection énumérable de conteneurs d’objets blob dont les noms commencent par le préfixe spécifié pour ce client de service Blob, à l’aide du paramètre 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 du nom du conteneur.
detailsIncluded - Valeur ContainerListingDetails qui indique si les métadonnées du conteneur seront retournées.
options - Objet BlobRequestOptions 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é ( CloudBlobClient).
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 CloudBlobContainer récupérés tardivement qui représente les conteneurs de ce client.

listContainersSegmented

public ResultSegment listContainersSegmented()

Retourne un segment de résultat d’une collection énumérable de conteneurs d’objets blob pour ce client de service Blob.

Returns:

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

Throws:

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

listContainersSegmented

public ResultSegment listContainersSegmented(final String prefix)

Retourne un segment de résultat d’une collection énumérable de conteneurs d’objets blob dont les noms commencent par le préfixe spécifié pour ce client de service Blob.

Parameters:

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

Returns:

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

Throws:

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

listContainersSegmented

public ResultSegment listContainersSegmented(final String prefix, final ContainerListingDetails detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final BlobRequestOptions options, final OperationContext opContext)

Retourne un segment de résultat d’une collection énumérable de conteneurs d’objets blob dont les noms commencent par le préfixe spécifié pour ce client de service Blob, à l’aide des options de détails de liste, 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 conteneur.
detailsIncluded - Valeur ContainerListingDetails qui indique si les métadonnées du conteneur seront retournées.
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 BlobRequestOptions 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é (CloudBlobClient).
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 CloudBlobContainer qui représentent les conteneurs pour ce client de service Blob.

Throws:

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

setDefaultRequestOptions

public void setDefaultRequestOptions(BlobRequestOptions defaultRequestOptions)

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

Parameters:

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

setDirectoryDelimiter

public void setDirectoryDelimiter(final String directoryDelimiter)

Définit la valeur du délimiteur par défaut utilisé pour les répertoires d’objets blob cloud.

Parameters:

directoryDelimiter - String qui spécifie la valeur du délimiteur de répertoire par défaut.

uploadServiceProperties

public void uploadServiceProperties(final ServiceProperties properties)

Charge une nouvelle ServiceProperties configuration sur le service de stockage donné. Cela inclut les configurations Logging, HourMetrics, MinuteMetrics et CORS.

Parameters:

properties - Objet ServiceProperties 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 ServiceProperties properties, BlobRequestOptions options, OperationContext opContext)

Charge une nouvelle ServiceProperties configuration sur le service de stockage donné. Cela inclut les configurations Logging, HourMetrics, MinuteMetrics et CORS.

Parameters:

properties - Objet ServiceProperties qui spécifie les propriétés de service à charger.
options - Objet BlobRequestOptions 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é ( CloudBlobClient).
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 à