CloudBlobClient Classe

Pacote:

com.microsoft.azure.storage.blob

• java.lang.Object
• • ServiceClient
  • • com.microsoft.azure.storage.blob.CloudBlobClient

public class CloudBlobClient extends ServiceClient

Fornece um cliente para acessar o serviço Blob do Microsoft Azure.

Essa classe fornece um ponto de acesso ao serviço Blob. O cliente de serviço encapsula o URI de base para o serviço Blob. Se o cliente de serviço for usado para o acesso autenticado, ele também encapsulará as credenciais para acessar a conta de armazenamento.

Resumo do Construtor

Construtor	Description
CloudBlobClient(final StorageUri baseUri)	Cria uma instância da classe usando o ponto de extremidade de serviço blob especificado e as credenciais anônimas.
CloudBlobClient(final StorageUri storageUri, StorageCredentials credentials)	Cria uma instância da classe usando o ponto de extremidade de serviço blob especificado e as credenciais da conta.
CloudBlobClient(final URI baseUri)	Cria uma instância da classe usando o ponto de extremidade de serviço blob especificado e as credenciais anônimas.
CloudBlobClient(final URI baseUri, StorageCredentials credentials)	Cria uma instância da classe usando o ponto de extremidade de serviço blob especificado e as credenciais da conta.

Resumo do método

Modificador e tipo	Método e descrição
AccountInformation	downloadAccountInfo() Obtém informações relacionadas à conta de armazenamento.
AccountInformation	downloadAccountInfo(BlobRequestOptions options, OperationContext opContext) Obtém informações relacionadas à conta de armazenamento.
StorageRequest<ServiceClient, Void, AccountInformation>	downloadAccountInformationImpl(final RequestOptions options)
final ServiceProperties	downloadServiceProperties() Recupera o atual ServiceProperties para o serviço de armazenamento especificado. Isso inclui configurações de Log, HourMetrics, MinuteMetrics e CORS.
final ServiceProperties	downloadServiceProperties(BlobRequestOptions options, OperationContext opContext) Recupera o atual ServiceProperties para o serviço de armazenamento especificado. Isso inclui configurações de Log, HourMetrics, MinuteMetrics e CORS.
<P, T> Map<P, T>	executeBatch(BlobBatchOperation<P, T> batch) Executa uma operação em lote pré-construída no serviço blob. Para obter mais informações sobre como construir solicitações em lote de blob, consulte BlobBatchOperation<P,R>.
<P, T> Map<P, T>	executeBatch(BlobBatchOperation<P, T> batch, BlobRequestOptions requestOptions, OperationContext operationContext) Executa uma operação em lote pré-construída no serviço blob. Para obter mais informações sobre como construir solicitações em lote de blob, consulte BlobBatchOperation<P,R>.
CloudBlobContainer	getContainerReference(final String containerName) Obtém um CloudBlobContainer objeto com o nome especificado.
BlobRequestOptions	getDefaultRequestOptions() Obtém o BlobRequestOptions que é usado para solicitações associadas a este
String	getDirectoryDelimiter() Retorna o valor do delimitador padrão usado para diretórios de blob de nuvem. O padrão é '/'.
ServiceStats	getServiceStats() Consulta o serviço para o ServiceStats.
ServiceStats	getServiceStats(BlobRequestOptions options, OperationContext opContext) Consulta o serviço de armazenamento especificado para o ServiceStats.
UserDelegationKey	getUserDelegationKey(Date keyStart, Date keyEnd) Solicita uma nova chave de delegação de usuário com base nas credenciais de oauth desse cliente.
UserDelegationKey	getUserDelegationKey(Date keyStart, Date keyEnd, BlobRequestOptions options, OperationContext opContext) Solicita uma nova chave de delegação de usuário com base nas credenciais de oauth desse cliente.
boolean	isUsePathStyleUris() Indica se os URIs de estilo de caminho estão sendo usados.
Iterable<CloudBlobContainer>	listContainers() Retorna uma coleção enumerável de contêineres de blob para esse cliente de serviço blob.
Iterable<CloudBlobContainer>	listContainers(final String prefix) Retorna uma coleção enumerável de contêineres de blob cujos nomes começam com o prefixo especificado para esse cliente de serviço blob.
Iterable<CloudBlobContainer>	listContainers(final String prefix, final ContainerListingDetails detailsIncluded, final BlobRequestOptions options, final OperationContext opContext) Retorna uma coleção enumerável de contêineres de blob cujos nomes começam com o prefixo especificado para esse cliente de serviço Blob, usando a configuração de detalhes especificada, as opções de solicitação e o contexto de operação.
ResultSegment<CloudBlobContainer>	listContainersSegmented() Retorna um segmento de resultado de uma coleção enumerável de contêineres de blob para esse cliente de serviço blob.
ResultSegment<CloudBlobContainer>	listContainersSegmented(final String prefix) Retorna um segmento de resultado de uma coleção enumerável de contêineres de blob cujos nomes começam com o prefixo especificado para esse cliente de serviço blob.
ResultSegment<CloudBlobContainer>	listContainersSegmented(final String prefix, final ContainerListingDetails detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final BlobRequestOptions options, final OperationContext opContext) Retorna um segmento de resultado de uma coleção enumerável de contêineres de blob cujos nomes começam com o prefixo especificado para esse cliente de serviço Blob, usando as opções de detalhes de listagem especificadas, as opções de solicitação e o contexto de operação.
void	setDefaultRequestOptions(BlobRequestOptions defaultRequestOptions) Define o BlobRequestOptions que é usado para todas as solicitações associadas a esse objeto.
void	setDirectoryDelimiter(final String directoryDelimiter) Define o valor do delimitador padrão usado para diretórios de blob de nuvem.
void	uploadServiceProperties(final ServiceProperties properties) Carrega uma nova ServiceProperties configuração para o serviço de armazenamento especificado. Isso inclui configurações de Log, HourMetrics, MinuteMetrics e CORS.
void	uploadServiceProperties(final ServiceProperties properties, BlobRequestOptions options, OperationContext opContext) Carrega uma nova ServiceProperties configuração para o serviço de armazenamento especificado. Isso inclui configurações de Log, HourMetrics, MinuteMetrics e CORS.

Membros herdados

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)

Detalhes do construtor

CloudBlobClient

public CloudBlobClient(final StorageUri baseUri)

Cria uma instância da classe usando o ponto de extremidade de serviço blob especificado e as credenciais anônimas.

Parameters:

baseUri - Um StorageUri objeto que representa o ponto de extremidade do serviço Blob usado para criar o cliente.

CloudBlobClient

public CloudBlobClient(final StorageUri storageUri, StorageCredentials credentials)

Cria uma instância da classe usando o ponto de extremidade de serviço blob especificado e as credenciais da conta.

Parameters:

storageUri - Um StorageUri objeto que representa o ponto de extremidade do serviço Blob usado para criar o cliente.

credentials - Um StorageCredentials objeto que representa as credenciais da conta.

CloudBlobClient

public CloudBlobClient(final URI baseUri)

Cria uma instância da classe usando o ponto de extremidade de serviço blob especificado e as credenciais anônimas.

Parameters:

baseUri - Um java.net.URI objeto que representa o ponto de extremidade do serviço Blob usado para criar o cliente.

CloudBlobClient

public CloudBlobClient(final URI baseUri, StorageCredentials credentials)

Cria uma instância da classe usando o ponto de extremidade de serviço blob especificado e as credenciais da conta.

Parameters:

baseUri - Um java.net.URI objeto que representa o ponto de extremidade do serviço Blob usado para criar o cliente.

credentials - Um StorageCredentials objeto que representa as credenciais da conta.

Detalhes do método

downloadAccountInfo

public AccountInformation downloadAccountInfo()

Obtém informações relacionadas à conta de armazenamento.

Returns:

Um AccountInformation objeto para a conta de armazenamento fornecida.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento.

downloadAccountInfo

public AccountInformation downloadAccountInfo(BlobRequestOptions options, OperationContext opContext)

Obtém informações relacionadas à conta de armazenamento.

Parameters:

options - Um BlobRequestOptions objeto que especifica as opções adicionais para a solicitação. A especificação null usará as opções de solicitação padrão do cliente de serviço associado ( CloudBlobClient).

opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Returns:

Um AccountInformation objeto para a conta de armazenamento fornecida.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento.

downloadAccountInformationImpl

protected StorageRequest downloadAccountInformationImpl(final RequestOptions options)

Parameters:

options

downloadServiceProperties

public final ServiceProperties downloadServiceProperties()

Recupera o atual ServiceProperties para o serviço de armazenamento especificado. Isso inclui configurações de Log, HourMetrics, MinuteMetrics e CORS.

Returns:

Um ServiceProperties objeto que representa a configuração atual do serviço.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento.

downloadServiceProperties

public final ServiceProperties downloadServiceProperties(BlobRequestOptions options, OperationContext opContext)

Recupera o atual ServiceProperties para o serviço de armazenamento especificado. Isso inclui configurações de Log, HourMetrics, MinuteMetrics e CORS.

Parameters:

options - Um BlobRequestOptions objeto que especifica as opções adicionais para a solicitação. A especificação null usará as opções de solicitação padrão do cliente de serviço associado ( CloudBlobClient).

opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Returns:

Um ServiceProperties objeto que representa a configuração atual do serviço.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento.

executeBatch

public Map executeBatch(BlobBatchOperation batch)

Executa uma operação em lote pré-construída no serviço blob. Para obter mais informações sobre como construir solicitações em lote de blob, consulte BlobBatchOperation<P,R>.

Parameters:

batch - O lote de operações a serem executadas.

Returns:

Um mapeamento do objeto pai no lote para a resposta desse pai.

Throws:

BatchException - Gera esse subconjunto de exceção de armazenamento se uma ou mais solicitações individuais no lote falharem.

StorageException - Gerará se ocorrer um erro com o serviço.

executeBatch

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

Executa uma operação em lote pré-construída no serviço blob. Para obter mais informações sobre como construir solicitações em lote de blob, consulte BlobBatchOperation<P,R>.

Parameters:

batch - O lote de operações a serem executadas.

requestOptions - Um BlobRequestOptions objeto que especifica as opções adicionais para a solicitação. A especificação null usará as opções de solicitação padrão do cliente de serviço associado ( CloudBlobClient).

operationContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Returns:

Um mapeamento do objeto pai no lote para a resposta desse pai.

Throws:

BatchException - Gera esse subconjunto de exceção de armazenamento se uma ou mais solicitações individuais no lote falharem.

StorageException - Gerará se ocorrer um erro com o serviço.

getContainerReference

public CloudBlobContainer getContainerReference(final String containerName)

Obtém um CloudBlobContainer objeto com o nome especificado.

Parameters:

containerName - O nome do contêiner, que deve seguir as regras de nomenclatura de contêiner. O nome do contêiner não deve incluir nenhum caractere separador de caminho (/). Os nomes de contêiner devem ser minúsculos, entre 3 e 63 caracteres e devem começar com uma letra ou número. Os nomes de contêiner podem conter apenas letras, números e o caractere de traço (-).

Returns:

Uma referência a um objeto CloudBlobContainer.

Throws:

URISyntaxException - Se o URI do recurso construído com base no containerName for inválido.

StorageException - Se ocorreu um erro de serviço de armazenamento.

getDefaultRequestOptions

public BlobRequestOptions getDefaultRequestOptions()

Obtém o BlobRequestOptions que é usado para solicitações associadas a este

Returns:

O BlobRequestOptions objeto que contém os valores usados por este CloudBlobClient

getDirectoryDelimiter

public String getDirectoryDelimiter()

Retorna o valor do delimitador padrão usado para diretórios de blob de nuvem. O padrão é '/'.

Returns:

Um String que representa o valor do delimitador padrão.

getServiceStats

public ServiceStats getServiceStats()

Consulta o serviço para o ServiceStats.

Returns:

Um ServiceStats objeto para o serviço de armazenamento fornecido.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento.

getServiceStats

public ServiceStats getServiceStats(BlobRequestOptions options, OperationContext opContext)

Consulta o serviço de armazenamento especificado para o ServiceStats.

Parameters:

options - Um BlobRequestOptions objeto que especifica as opções adicionais para a solicitação. A especificação null usará as opções de solicitação padrão do cliente de serviço associado ( CloudBlobClient).

opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Returns:

Um ServiceStats objeto para o serviço de armazenamento fornecido.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento.

getUserDelegationKey

public UserDelegationKey getUserDelegationKey(Date keyStart, Date keyEnd)

Solicita uma nova chave de delegação de usuário com base nas credenciais de oauth desse cliente.

Parameters:

keyStart - Hora de início da validade da chave solicitada.

keyEnd - Hora de término da validade da chave solicitada.

Returns:

A chave solicitada.

Throws:

StorageException

getUserDelegationKey

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

Solicita uma nova chave de delegação de usuário com base nas credenciais de oauth desse cliente.

Parameters:

keyStart - Hora de início da validade da chave solicitada.

keyEnd - Hora de término da validade da chave solicitada.

options - Um BlobRequestOptions objeto que especifica as opções adicionais para a solicitação. A especificação null usará as opções de solicitação padrão do cliente de serviço associado ( CloudBlobClient).

opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Returns:

A chave solicitada.

Throws:

StorageException

isUsePathStyleUris

protected boolean isUsePathStyleUris()

Indica se os URIs de estilo de caminho estão sendo usados.

Returns:

true se estiver usando URIs de estilo de caminho; caso contrário, false.

listContainers

public Iterable listContainers()

Retorna uma coleção enumerável de contêineres de blob para esse cliente de serviço blob.

Returns:

Uma coleção enumerável de CloudBlobContainer objetos recuperados de forma preguiçosa que representam os contêineres desse cliente.

listContainers

public Iterable listContainers(final String prefix)

Retorna uma coleção enumerável de contêineres de blob cujos nomes começam com o prefixo especificado para esse cliente de serviço blob.

Parameters:

prefix - Um String que representa o prefixo do nome do contêiner.

Returns:

Uma coleção enumerável de CloudBlobContainer objetos recuperados lentamente que representam os contêineres para esse cliente cujos nomes começam com o prefixo especificado.

listContainers

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

Retorna uma coleção enumerável de contêineres de blob cujos nomes começam com o prefixo especificado para esse cliente de serviço Blob, usando a configuração de detalhes especificada, as opções de solicitação e o contexto de operação.

Parameters:

prefix - Um String que representa o prefixo do nome do contêiner.

detailsIncluded - Um ContainerListingDetails valor que indica se os metadados de contêiner serão retornados.

options - Um BlobRequestOptions objeto que especifica as opções adicionais para a solicitação. A especificação null usará as opções de solicitação padrão do cliente de serviço associado ( CloudBlobClient).

opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Returns:

Uma coleção enumerável de CloudBlobContainer objetos recuperados de forma preguiçosa que representa os contêineres desse cliente.

listContainersSegmented

public ResultSegment listContainersSegmented()

Retorna um segmento de resultado de uma coleção enumerável de contêineres de blob para esse cliente de serviço blob.

Returns:

Um ResultSegment<T> objeto que contém um segmento da coleção enumerável de CloudBlobContainer objetos que representam os contêineres para esse cliente.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento.

listContainersSegmented

public ResultSegment listContainersSegmented(final String prefix)

Retorna um segmento de resultado de uma coleção enumerável de contêineres de blob cujos nomes começam com o prefixo especificado para esse cliente de serviço blob.

Parameters:

prefix - Um String que representa o prefixo do nome do contêiner.

Returns:

Um ResultSegment<T> objeto que contém um segmento da coleção enumerável de CloudBlobContainer objetos que representam os contêineres cujos nomes começam com o prefixo especificado.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento.

listContainersSegmented

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

Retorna um segmento de resultado de uma coleção enumerável de contêineres de blob cujos nomes começam com o prefixo especificado para esse cliente de serviço Blob, usando as opções de detalhes de listagem especificadas, as opções de solicitação e o contexto de operação.

Parameters:

prefix - Um String que representa o prefixo do nome do contêiner.

detailsIncluded - Um ContainerListingDetails valor que indica se os metadados de contêiner serão retornados.

maxResults - O número máximo de resultados a serem recuperados. Se null ou maior que 5000, o servidor retornará até 5.000 itens. Deve ser pelo menos 1.

continuationToken - Um ResultContinuation objeto que representa um token de continuação retornado por uma operação de listagem anterior.

options - Um BlobRequestOptions objeto que especifica as opções adicionais para a solicitação. A especificação null usará as opções de solicitação padrão do cliente de serviço associado (CloudBlobClient).

opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Returns:

Um ResultSegment<T> objeto que contém um segmento da coleção enumerável de CloudBlobContainer objetos que representam os contêineres para esse cliente de serviço Blob.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento.

setDefaultRequestOptions

public void setDefaultRequestOptions(BlobRequestOptions defaultRequestOptions)

Define o BlobRequestOptions que é usado para todas as solicitações associadas a esse objeto.

Parameters:

defaultRequestOptions - Um BlobRequestOptions objeto que especifica as opções a serem usadas.

setDirectoryDelimiter

public void setDirectoryDelimiter(final String directoryDelimiter)

Define o valor do delimitador padrão usado para diretórios de blob de nuvem.

Parameters:

directoryDelimiter - Um String que especifica o valor do delimitador de diretório padrão.

uploadServiceProperties

public void uploadServiceProperties(final ServiceProperties properties)

Carrega uma nova ServiceProperties configuração para o serviço de armazenamento especificado. Isso inclui configurações de Log, HourMetrics, MinuteMetrics e CORS.

Parameters:

properties - Um ServiceProperties objeto que especifica as propriedades de serviço a serem carregadas.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento.

uploadServiceProperties

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

Carrega uma nova ServiceProperties configuração para o serviço de armazenamento especificado. Isso inclui configurações de Log, HourMetrics, MinuteMetrics e CORS.

Parameters:

properties - Um ServiceProperties objeto que especifica as propriedades de serviço a serem carregadas.

options - Um BlobRequestOptions objeto que especifica as opções adicionais para a solicitação. Especificar null usará as opções de solicitação padrão do cliente de serviço associado ( CloudBlobClient).

opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento.