CloudFileClient Classe

Pacote:

com.microsoft.azure.storage.file

• java.lang.Object
• • ServiceClient
  • • com.microsoft.azure.storage.file.CloudFileClient

public class CloudFileClient extends ServiceClient

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

Essa classe fornece um ponto de acesso ao serviço arquivo. O cliente de serviço encapsula o URI de base para o serviço de Arquivo. Ele também encapsula as credenciais para acessar a conta de armazenamento.

Resumo do Construtor

Construtor	Description
CloudFileClient(final URI baseUri, StorageCredentials credentials)	Cria uma instância da classe usando as credenciais de conta e o ponto de extremidade de serviço de arquivo especificados.
CloudFileClient(StorageUri storageUri, StorageCredentials credentials)	Cria uma instância da classe usando as credenciais de conta e o ponto de extremidade de serviço de arquivo especificados.

Resumo do método

Modificador e tipo	Método e descrição
final FileServiceProperties	downloadServiceProperties() Recupera o atual FileServiceProperties para o serviço de armazenamento especificado. Isso encapsula as configurações do CORS.
final FileServiceProperties	downloadServiceProperties(FileRequestOptions options, OperationContext opContext) Recupera o atual FileServiceProperties para o serviço de armazenamento especificado. Isso encapsula as configurações do CORS.
FileRequestOptions	getDefaultRequestOptions() Obtém o FileRequestOptions que é usado para solicitações associadas a este
CloudFileShare	getShareReference(final String shareName) Obtém um CloudFileShare objeto com o nome especificado.
CloudFileShare	getShareReference(final String shareName, String snapshotID) Obtém um CloudFileShare objeto com o nome especificado.
boolean	isUsePathStyleUris() Indica se os URIs de estilo de caminho estão sendo usados.
Iterable<CloudFileShare>	listShares() Retorna uma coleção enumerável de compartilhamentos para este cliente de serviço de arquivo.
Iterable<CloudFileShare>	listShares(final String prefix) Retorna uma coleção enumerável de compartilhamentos cujos nomes começam com o prefixo especificado para este cliente de serviço de arquivo.
Iterable<CloudFileShare>	listShares(final String prefix, final EnumSet<ShareListingDetails> detailsIncluded, final FileRequestOptions options, final OperationContext opContext) Retorna uma coleção enumerável de compartilhamentos cujos nomes começam com o prefixo especificado para esse cliente de serviço de arquivo, usando as configurações de detalhes especificadas, as opções de solicitação e o contexto de operação.
ResultSegment<CloudFileShare>	listSharesSegmented() Retorna um segmento de resultado de uma coleção enumerável de compartilhamentos para este cliente de serviço de arquivo.
ResultSegment<CloudFileShare>	listSharesSegmented(final String prefix) Retorna um segmento de resultado de uma coleção enumerável de compartilhamentos cujos nomes começam com o prefixo especificado para este cliente de serviço de arquivo.
ResultSegment<CloudFileShare>	listSharesSegmented(final String prefix, final EnumSet<ShareListingDetails> detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final FileRequestOptions options, final OperationContext opContext) Retorna um segmento de resultado de uma coleção enumerável de compartilhamentos cujos nomes começam com o prefixo especificado, usando as opções de detalhes de listagem especificadas, opções de solicitação e contexto de operação.
void	setDefaultRequestOptions(FileRequestOptions defaultRequestOptions) Define o FileRequestOptions que é usado para quaisquer solicitações associadas a esse objeto.
void	uploadServiceProperties(final FileServiceProperties properties) Carrega uma nova FileServiceProperties configuração para o serviço de armazenamento especificado. Isso encapsula as configurações do CORS.
void	uploadServiceProperties(final FileServiceProperties properties, FileRequestOptions options, OperationContext opContext) Carrega uma nova FileServiceProperties configuração para o serviço de armazenamento especificado. Isso encapsula as configurações do 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

CloudFileClient

public CloudFileClient(final URI baseUri, StorageCredentials credentials)

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

Parameters:

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

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

CloudFileClient

public CloudFileClient(StorageUri storageUri, StorageCredentials credentials)

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

Parameters:

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

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

Detalhes do método

downloadServiceProperties

public final FileServiceProperties downloadServiceProperties()

Recupera o atual FileServiceProperties para o serviço de armazenamento especificado. Isso encapsula as configurações do CORS.

Returns:

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

Throws:

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

downloadServiceProperties

public final FileServiceProperties downloadServiceProperties(FileRequestOptions options, OperationContext opContext)

Recupera o atual FileServiceProperties para o serviço de armazenamento especificado. Isso encapsula as configurações do CORS.

Parameters:

options - Um FileRequestOptions 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 (CloudFileClient).

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 FileServiceProperties objeto que representa a configuração atual do serviço.

Throws:

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

getDefaultRequestOptions

public FileRequestOptions getDefaultRequestOptions()

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

Returns:

O FileRequestOptions objeto que contém os valores usados por este CloudFileClient

getShareReference

public CloudFileShare getShareReference(final String shareName)

Obtém um CloudFileShare objeto com o nome especificado.

Parameters:

shareName - O nome do compartilhamento, que deve aderir às regras de nomenclatura de compartilhamento. O nome do compartilhamento não deve incluir nenhum caractere separador de caminho (/). Os nomes de compartilhamento devem estar em minúsculas, entre 3 e 63 caracteres e devem começar com uma letra ou número. Os nomes de compartilhamento podem conter apenas letras, números e o caractere traço (-).

Returns:

Uma referência a um objeto CloudFileShare.

Throws:

StorageException

URISyntaxException

getShareReference

public CloudFileShare getShareReference(final String shareName, String snapshotID)

Obtém um CloudFileShare objeto com o nome especificado.

Parameters:

shareName - O nome do compartilhamento, que deve aderir às regras de nomenclatura de compartilhamento. O nome do compartilhamento não deve incluir nenhum caractere separador de caminho (/). Os nomes de compartilhamento devem estar em minúsculas, entre 3 e 63 caracteres e devem começar com uma letra ou número. Os nomes de compartilhamento podem conter apenas letras, números e o caractere traço (-).

snapshotID - Um String que representa a ID de instantâneo do compartilhamento.

Returns:

Uma referência a um objeto CloudFileShare.

Throws:

StorageException

URISyntaxException

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.

listShares

public Iterable listShares()

Retorna uma coleção enumerável de compartilhamentos para este cliente de serviço de arquivo.

Returns:

Uma coleção enumerável de CloudFileShare objetos recuperados lentamente que representam os compartilhamentos para esse cliente.

listShares

public Iterable listShares(final String prefix)

Retorna uma coleção enumerável de compartilhamentos cujos nomes começam com o prefixo especificado para este cliente de serviço de arquivo.

Parameters:

prefix - Um String que representa o prefixo do nome do compartilhamento.

Returns:

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

listShares

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

Retorna uma coleção enumerável de compartilhamentos cujos nomes começam com o prefixo especificado para esse cliente de serviço de arquivo, usando as configurações de detalhes especificadas, as opções de solicitação e o contexto de operação.

Parameters:

prefix - Um String que representa o prefixo do nome do compartilhamento.

detailsIncluded - Um java.util.EnumSet objeto que contém ShareListingDetails valores que indicam se instantâneos de compartilhamento e/ou metadados serão retornados.

options - Um FileRequestOptions 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 ( CloudFileClient).

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 CloudFileShare objetos recuperados de forma preguiçosa que representa os compartilhamentos desse cliente.

listSharesSegmented

public ResultSegment listSharesSegmented()

Retorna um segmento de resultado de uma coleção enumerável de compartilhamentos para este cliente de serviço de arquivo.

Returns:

Um ResultSegment<T> objeto que contém um segmento da coleção enumerável de CloudFileShare objetos que representam os compartilhamentos desse cliente.

Throws:

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

listSharesSegmented

public ResultSegment listSharesSegmented(final String prefix)

Retorna um segmento de resultado de uma coleção enumerável de compartilhamentos cujos nomes começam com o prefixo especificado para este cliente de serviço de arquivo.

Parameters:

prefix - Um String que representa o prefixo do nome do compartilhamento.

Returns:

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

Throws:

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

listSharesSegmented

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

Retorna um segmento de resultado de uma coleção enumerável de compartilhamentos cujos nomes começam com o prefixo especificado, usando as opções de detalhes de listagem especificadas, opções de solicitação e contexto de operação.

Parameters:

prefix - Um String que representa o prefixo do nome do compartilhamento.

detailsIncluded - Um java.util.EnumSet objeto que contém ShareListingDetails valores que indicam se os instantâneos de compartilhamento e/ou metadados 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 FileRequestOptions 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 ( CloudFileClient).

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 CloudFileShare objetos que representam os compartilhamentos desse cliente.

Throws:

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

setDefaultRequestOptions

public void setDefaultRequestOptions(FileRequestOptions defaultRequestOptions)

Define o FileRequestOptions que é usado para quaisquer solicitações associadas a esse objeto.

Parameters:

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

uploadServiceProperties

public void uploadServiceProperties(final FileServiceProperties properties)

Carrega uma nova FileServiceProperties configuração para o serviço de armazenamento especificado. Isso encapsula as configurações do CORS.

Parameters:

properties - Um FileServiceProperties 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 FileServiceProperties properties, FileRequestOptions options, OperationContext opContext)

Carrega uma nova FileServiceProperties configuração para o serviço de armazenamento especificado. Isso encapsula as configurações do CORS.

Parameters:

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

options - Um FileRequestOptions 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 (CloudFileClient).

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.