CloudBlobClient Clase

  • Referencia
Paquete:
com.microsoft.azure.storage.blob
  • java.lang.Object

public class CloudBlobClient extends ServiceClient

Proporciona un cliente para acceder al servicio Microsoft Azure Blob.

Esta clase proporciona un punto de acceso al servicio Blob. El cliente del servicio encapsula el URI base para el servicio Blob. Si el cliente del servicio se va a usar para el acceso autenticado, también encapsula las credenciales de acceso a la cuenta de almacenamiento.

Resumen del constructor

Constructor Description
CloudBlobClient(final StorageUri baseUri)

Crea una instancia de la clase mediante el punto de conexión de Blob service y las credenciales anónimas especificadas.
CloudBlobClient(final StorageUri storageUri, StorageCredentials credentials)

Crea una instancia de la clase con las credenciales de cuenta y el punto de conexión de Blob service especificados.
CloudBlobClient(final URI baseUri)

Crea una instancia de la clase mediante el punto de conexión de Blob service y las credenciales anónimas especificadas.
CloudBlobClient(final URI baseUri, StorageCredentials credentials)

Crea una instancia de la clase con las credenciales de cuenta y el punto de conexión de Blob service especificados.

Resumen del método

Modificador y tipo Método y descripción
AccountInformation downloadAccountInfo()

Obtiene información relacionada con la cuenta de almacenamiento.
AccountInformation downloadAccountInfo(BlobRequestOptions options, OperationContext opContext)

Obtiene información relacionada con la cuenta de almacenamiento.
StorageRequest<ServiceClient, Void, AccountInformation> downloadAccountInformationImpl(final RequestOptions options)
final ServiceProperties downloadServiceProperties()

Recupera el actual ServiceProperties para el servicio de almacenamiento determinado. Esto incluye las configuraciones registro, HourMetrics, MinuteMetrics y CORS.
final ServiceProperties downloadServiceProperties(BlobRequestOptions options, OperationContext opContext)

Recupera el actual ServiceProperties para el servicio de almacenamiento determinado. Esto incluye las configuraciones registro, HourMetrics, MinuteMetrics y CORS.
<P, T> Map<P, T> executeBatch(BlobBatchOperation<P, T> batch)

Ejecuta una operación por lotes predeconstruida en blob service. Para más información sobre cómo construir solicitudes por lotes de blobs, consulte BlobBatchOperation<P,R>.
<P, T> Map<P, T> executeBatch(BlobBatchOperation<P, T> batch, BlobRequestOptions requestOptions, OperationContext operationContext)

Ejecuta una operación por lotes predeconstruida en blob service. Para más información sobre cómo construir solicitudes por lotes de blobs, consulte BlobBatchOperation<P,R>.
CloudBlobContainer getContainerReference(final String containerName)

Obtiene un CloudBlobContainer objeto con el nombre especificado.
BlobRequestOptions getDefaultRequestOptions()

Obtiene el BlobRequestOptions objeto que se usa para las solicitudes asociadas a este objeto.
String getDirectoryDelimiter()

Devuelve el valor del delimitador predeterminado que se usa para los directorios de blobs en la nube. El valor predeterminado es "/".
ServiceStats getServiceStats()

Consulta el servicio para .ServiceStats
ServiceStats getServiceStats(BlobRequestOptions options, OperationContext opContext)

Consulta el servicio de almacenamiento especificado para .ServiceStats
UserDelegationKey getUserDelegationKey(Date keyStart, Date keyEnd)

Solicita una nueva clave de delegación de usuarios basada en las credenciales de oauth de este cliente.

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

Solicita una nueva clave de delegación de usuarios basada en las credenciales de oauth de este cliente.

boolean isUsePathStyleUris()

Indica si se usan URI de estilo de ruta de acceso.
Iterable<CloudBlobContainer> listContainers()

Devuelve una colección enumerable de contenedores de blobs para este cliente de Blob Service.
Iterable<CloudBlobContainer> listContainers(final String prefix)

Devuelve una colección enumerable de contenedores de blobs cuyos nombres comienzan con el prefijo especificado para este cliente de Blob Service.
Iterable<CloudBlobContainer> listContainers(final String prefix, final ContainerListingDetails detailsIncluded, final BlobRequestOptions options, final OperationContext opContext)

Devuelve una colección enumerable de contenedores de blobs cuyos nombres comienzan con el prefijo especificado para este cliente de Blob Service, mediante la configuración de detalles, las opciones de solicitud y el contexto de operación especificados.
ResultSegment<CloudBlobContainer> listContainersSegmented()

Devuelve un segmento de resultado de una colección enumerable de contenedores de blobs para este cliente de Blob Service.
ResultSegment<CloudBlobContainer> listContainersSegmented(final String prefix)

Devuelve un segmento de resultado de una colección enumerable de contenedores de blobs cuyos nombres comienzan con el prefijo especificado para este cliente de Blob Service.
ResultSegment<CloudBlobContainer> listContainersSegmented(final String prefix, final ContainerListingDetails detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final BlobRequestOptions options, final OperationContext opContext)

Devuelve un segmento de resultado de una colección enumerable de contenedores de blobs cuyos nombres comienzan con el prefijo especificado para este cliente de Blob Service, mediante las opciones de detalles de la lista especificadas, las opciones de solicitud y el contexto de la operación.
void setDefaultRequestOptions(BlobRequestOptions defaultRequestOptions)

Establece el BlobRequestOptions objeto que se usa para las solicitudes asociadas a este objeto.
void setDirectoryDelimiter(final String directoryDelimiter)

Establece el valor del delimitador predeterminado que se usa para los directorios de blobs en la nube.
void uploadServiceProperties(final ServiceProperties properties)

Carga una nueva ServiceProperties configuración en el servicio de almacenamiento determinado. Esto incluye las configuraciones registro, HourMetrics, MinuteMetrics y CORS.
void uploadServiceProperties(final ServiceProperties properties, BlobRequestOptions options, OperationContext opContext)

Carga una nueva ServiceProperties configuración en el servicio de almacenamiento determinado. Esto incluye las configuraciones registro, HourMetrics, MinuteMetrics y CORS.

Miembros heredados

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)

Detalles del constructor

CloudBlobClient

public CloudBlobClient(final StorageUri baseUri)

Crea una instancia de la clase mediante el punto de conexión de Blob service y las credenciales anónimas especificadas.

Parameters:

baseUri - Objeto StorageUri que representa el punto de conexión de Blob service que se usa para crear el cliente.

CloudBlobClient

public CloudBlobClient(final StorageUri storageUri, StorageCredentials credentials)

Crea una instancia de la clase con las credenciales de cuenta y el punto de conexión de Blob service especificados.

Parameters:

storageUri - Objeto StorageUri que representa el punto de conexión de Blob service que se usa para crear el cliente.
credentials - Objeto StorageCredentials que representa las credenciales de la cuenta.

CloudBlobClient

public CloudBlobClient(final URI baseUri)

Crea una instancia de la clase mediante el punto de conexión de Blob service y las credenciales anónimas especificadas.

Parameters:

baseUri - Objeto java.net.URI que representa el punto de conexión de Blob service que se usa para crear el cliente.

CloudBlobClient

public CloudBlobClient(final URI baseUri, StorageCredentials credentials)

Crea una instancia de la clase con las credenciales de cuenta y el punto de conexión de Blob service especificados.

Parameters:

baseUri - Objeto java.net.URI que representa el punto de conexión de Blob service que se usa para crear el cliente.
credentials - Objeto StorageCredentials que representa las credenciales de la cuenta.

Detalles del método

downloadAccountInfo

public AccountInformation downloadAccountInfo()

Obtiene información relacionada con la cuenta de almacenamiento.

Returns:

Objeto AccountInformation para la cuenta de almacenamiento especificada.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.

downloadAccountInfo

public AccountInformation downloadAccountInfo(BlobRequestOptions options, OperationContext opContext)

Obtiene información relacionada con la cuenta de almacenamiento.

Parameters:

options - Objeto BlobRequestOptions que especifica las opciones adicionales de la solicitud. Al especificar null , se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudBlobClient).
opContext - Objeto OperationContext que representa el contexto para la operación actual. Este objeto se utiliza para hacer un seguimiento de las solicitudes al servicio de almacenamiento y para proporcionar información adicional en tiempo de ejecución sobre la operación.

Returns:

Objeto AccountInformation para la cuenta de almacenamiento especificada.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.

downloadAccountInformationImpl

protected StorageRequest downloadAccountInformationImpl(final RequestOptions options)

Parameters:

options

downloadServiceProperties

public final ServiceProperties downloadServiceProperties()

Recupera el actual ServiceProperties para el servicio de almacenamiento determinado. Esto incluye las configuraciones registro, HourMetrics, MinuteMetrics y CORS.

Returns:

Objeto ServiceProperties que representa la configuración actual del servicio.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.

downloadServiceProperties

public final ServiceProperties downloadServiceProperties(BlobRequestOptions options, OperationContext opContext)

Recupera el actual ServiceProperties para el servicio de almacenamiento determinado. Esto incluye las configuraciones registro, HourMetrics, MinuteMetrics y CORS.

Parameters:

options - Objeto BlobRequestOptions que especifica las opciones adicionales de la solicitud. Al especificar null , se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudBlobClient).
opContext - Objeto OperationContext que representa el contexto para la operación actual. Este objeto se utiliza para hacer un seguimiento de las solicitudes al servicio de almacenamiento y para proporcionar información adicional en tiempo de ejecución sobre la operación.

Returns:

Objeto ServiceProperties que representa la configuración actual del servicio.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.

executeBatch

public Map executeBatch(BlobBatchOperation batch)

Ejecuta una operación por lotes predeconstruida en blob service. Para más información sobre cómo construir solicitudes por lotes de blobs, consulte BlobBatchOperation<P,R>.

Parameters:

batch - Lote de operaciones que se van a ejecutar.

Returns:

Asignación del objeto primario del lote a la respuesta de ese elemento primario.

Throws:

BatchException - Produce este subconjunto de excepciones de almacenamiento si se produce un error en una o varias solicitudes individuales en el lote.
StorageException - Produce si se produce un error con el servicio.

executeBatch

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

Ejecuta una operación por lotes predeconstruida en blob service. Para más información sobre cómo construir solicitudes por lotes de blobs, consulte BlobBatchOperation<P,R>.

Parameters:

batch - Lote de operaciones que se van a ejecutar.
requestOptions - Objeto BlobRequestOptions que especifica las opciones adicionales de la solicitud. Al especificar null , se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudBlobClient).
operationContext - Objeto OperationContext que representa el contexto para la operación actual. Este objeto se utiliza para hacer un seguimiento de las solicitudes al servicio de almacenamiento y para proporcionar información adicional en tiempo de ejecución sobre la operación.

Returns:

Asignación del objeto primario del lote a la respuesta de ese elemento primario.

Throws:

BatchException - Produce este subconjunto de excepciones de almacenamiento si se produce un error en una o varias solicitudes individuales en el lote.
StorageException - Produce si se produce un error con el servicio.

getContainerReference

public CloudBlobContainer getContainerReference(final String containerName)

Obtiene un CloudBlobContainer objeto con el nombre especificado.

Parameters:

containerName - Nombre del contenedor, que debe cumplir las reglas de nomenclatura del contenedor. El nombre del contenedor no debe incluir ningún carácter separador de ruta de acceso (/). Los nombres de contenedor deben estar en minúsculas, entre 3 y 63 caracteres y deben comenzar con una letra o un número. Los nombres de contenedor solo pueden contener letras, números y el carácter de guión (-).

Returns:

Referencia a un objeto CloudBlobContainer.

Throws:

URISyntaxException - Si el URI del recurso construido basado en containerName no es válido.
StorageException - Si se produjo un error en el servicio de almacenamiento.

getDefaultRequestOptions

public BlobRequestOptions getDefaultRequestOptions()

Obtiene el BlobRequestOptions objeto que se usa para las solicitudes asociadas a este objeto.

Returns:

Objeto BlobRequestOptions que contiene los valores usados por este objeto. CloudBlobClient

getDirectoryDelimiter

public String getDirectoryDelimiter()

Devuelve el valor del delimitador predeterminado que se usa para los directorios de blobs en la nube. El valor predeterminado es "/".

Returns:

que String representa el valor del delimitador predeterminado.

getServiceStats

public ServiceStats getServiceStats()

Consulta el servicio para .ServiceStats

Returns:

Objeto ServiceStats para el servicio de almacenamiento especificado.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.

getServiceStats

public ServiceStats getServiceStats(BlobRequestOptions options, OperationContext opContext)

Consulta el servicio de almacenamiento especificado para .ServiceStats

Parameters:

options - Objeto BlobRequestOptions que especifica las opciones adicionales de la solicitud. Al especificar null , se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudBlobClient).
opContext - Objeto OperationContext que representa el contexto para la operación actual. Este objeto se utiliza para hacer un seguimiento de las solicitudes al servicio de almacenamiento y para proporcionar información adicional en tiempo de ejecución sobre la operación.

Returns:

Objeto ServiceStats para el servicio de almacenamiento especificado.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.

getUserDelegationKey

public UserDelegationKey getUserDelegationKey(Date keyStart, Date keyEnd)

Solicita una nueva clave de delegación de usuarios basada en las credenciales de oauth de este cliente.

Parameters:

keyStart - Hora de inicio de la validez de la clave solicitada.
keyEnd - Hora de finalización de la validez de la clave solicitada.

Returns:

Clave solicitada.

Throws:

StorageException

getUserDelegationKey

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

Solicita una nueva clave de delegación de usuarios basada en las credenciales de oauth de este cliente.

Parameters:

keyStart - Hora de inicio de la validez de la clave solicitada.
keyEnd - Hora de finalización de la validez de la clave solicitada.
options - Objeto BlobRequestOptions que especifica las opciones adicionales de la solicitud. Al especificar null , se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudBlobClient).
opContext - Objeto OperationContext que representa el contexto para la operación actual. Este objeto se utiliza para hacer un seguimiento de las solicitudes al servicio de almacenamiento y para proporcionar información adicional en tiempo de ejecución sobre la operación.

Returns:

Clave solicitada.

Throws:

StorageException

isUsePathStyleUris

protected boolean isUsePathStyleUris()

Indica si se usan URI de estilo de ruta de acceso.

Returns:

true si usa URI de estilo de ruta de acceso; de lo contrario, false.

listContainers

public Iterable listContainers()

Devuelve una colección enumerable de contenedores de blobs para este cliente de Blob Service.

Returns:

Colección enumerable de CloudBlobContainer objetos recuperados de forma diferida que representan los contenedores de este cliente.

listContainers

public Iterable listContainers(final String prefix)

Devuelve una colección enumerable de contenedores de blobs cuyos nombres comienzan con el prefijo especificado para este cliente de Blob Service.

Parameters:

prefix - que String representa el prefijo del nombre del contenedor.

Returns:

Colección enumerable de CloudBlobContainer objetos recuperados de forma diferida que representan los contenedores de este cliente cuyos nombres comienzan por el prefijo especificado.

listContainers

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

Devuelve una colección enumerable de contenedores de blobs cuyos nombres comienzan con el prefijo especificado para este cliente de Blob Service, mediante la configuración de detalles, las opciones de solicitud y el contexto de operación especificados.

Parameters:

prefix - que String representa el prefijo del nombre del contenedor.
detailsIncluded - Valor ContainerListingDetails que indica si se devolverán metadatos de contenedor.
options - Objeto BlobRequestOptions que especifica las opciones adicionales de la solicitud. Al especificar null , se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudBlobClient).
opContext - Objeto OperationContext que representa el contexto para la operación actual. Este objeto se utiliza para hacer un seguimiento de las solicitudes al servicio de almacenamiento y para proporcionar información adicional en tiempo de ejecución sobre la operación.

Returns:

Colección enumerable de CloudBlobContainer objetos recuperados de forma diferida que representa los contenedores de este cliente.

listContainersSegmented

public ResultSegment listContainersSegmented()

Devuelve un segmento de resultado de una colección enumerable de contenedores de blobs para este cliente de Blob Service.

Returns:

Objeto ResultSegment<T> que contiene un segmento de la colección enumerable de CloudBlobContainer objetos que representan los contenedores de este cliente.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.

listContainersSegmented

public ResultSegment listContainersSegmented(final String prefix)

Devuelve un segmento de resultado de una colección enumerable de contenedores de blobs cuyos nombres comienzan con el prefijo especificado para este cliente de Blob Service.

Parameters:

prefix - que String representa el prefijo del nombre del contenedor.

Returns:

Objeto ResultSegment<T> que contiene un segmento de la colección enumerable de CloudBlobContainer objetos que representan los contenedores cuyos nombres comienzan con el prefijo especificado.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.

listContainersSegmented

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

Devuelve un segmento de resultado de una colección enumerable de contenedores de blobs cuyos nombres comienzan con el prefijo especificado para este cliente de Blob Service, mediante las opciones de detalles de la lista especificadas, las opciones de solicitud y el contexto de la operación.

Parameters:

prefix - que String representa el prefijo del nombre del contenedor.
detailsIncluded - Valor ContainerListingDetails que indica si se devolverán metadatos de contenedor.
maxResults - Número máximo de resultados que se van a recuperar. Si null o superior a 5000, el servidor devolverá hasta 5000 elementos. Debe ser 1 como mínimo.
continuationToken - Objeto ResultContinuation que representa un token de continuación devuelto por una operación de lista anterior.
options - Objeto BlobRequestOptions que especifica las opciones adicionales de la solicitud. Al especificar null , se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado (CloudBlobClient).
opContext - Objeto OperationContext que representa el contexto para la operación actual. Este objeto se utiliza para hacer un seguimiento de las solicitudes al servicio de almacenamiento y para proporcionar información adicional en tiempo de ejecución sobre la operación.

Returns:

Objeto ResultSegment<T> que contiene un segmento de la colección enumerable de CloudBlobContainer objetos que representan los contenedores para este cliente de Blob Service.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.

setDefaultRequestOptions

public void setDefaultRequestOptions(BlobRequestOptions defaultRequestOptions)

Establece el BlobRequestOptions objeto que se usa para las solicitudes asociadas a este objeto.

Parameters:

defaultRequestOptions - Objeto BlobRequestOptions que especifica las opciones que se van a usar.

setDirectoryDelimiter

public void setDirectoryDelimiter(final String directoryDelimiter)

Establece el valor del delimitador predeterminado que se usa para los directorios de blobs en la nube.

Parameters:

directoryDelimiter - que String especifica el valor del delimitador de directorio predeterminado.

uploadServiceProperties

public void uploadServiceProperties(final ServiceProperties properties)

Carga una nueva ServiceProperties configuración en el servicio de almacenamiento determinado. Esto incluye las configuraciones registro, HourMetrics, MinuteMetrics y CORS.

Parameters:

properties - Objeto ServiceProperties que especifica las propiedades del servicio que se van a cargar.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.

uploadServiceProperties

public void uploadServiceProperties(final ServiceProperties properties, BlobRequestOptions options, OperationContext opContext)

Carga una nueva ServiceProperties configuración en el servicio de almacenamiento determinado. Esto incluye las configuraciones registro, HourMetrics, MinuteMetrics y CORS.

Parameters:

properties - Objeto ServiceProperties que especifica las propiedades del servicio que se van a cargar.
options - Objeto BlobRequestOptions que especifica las opciones adicionales de la solicitud. Al especificar null , se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudBlobClient).
opContext - Objeto OperationContext que representa el contexto para la operación actual. Este objeto se utiliza para hacer un seguimiento de las solicitudes al servicio de almacenamiento y para proporcionar información adicional en tiempo de ejecución sobre la operación.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.

Se aplica a