CloudFileShare Classe

Pacote:

com.microsoft.azure.storage.file

• java.lang.Object
• • com.microsoft.azure.storage.file.CloudFileShare

public class CloudFileShare

Representa um compartilhamento no serviço arquivo do Microsoft Azure.

Os compartilhamentos mantêm diretórios, que são encapsulados como CloudFileDirectory objetos, e os diretórios mantêm arquivos. Os diretórios também podem conter subdiretórios.

Resumo do Construtor

Construtor	Description
CloudFileShare(final StorageUri storageUri)	Cria uma instância da classe usando o URI especificado.
CloudFileShare(final StorageUri storageUri, final StorageCredentials credentials)	Cria uma instância da classe usando o StorageUri e as credenciais especificados.
CloudFileShare(final String shareName, String snapshotID, final CloudFileClient client)	Cria uma instância da classe usando o nome e o cliente especificados.
CloudFileShare(final URI uri)	Cria uma instância da classe usando o URI especificado.
CloudFileShare(final URI uri, final StorageCredentials credentials)	Cria uma instância da classe usando o URI e as credenciais especificados.

Resumo do método

Modificador e tipo	Método e descrição
void	assertNoSnapshot() Afirma que o compartilhamento não é um instantâneo.
void	create() Cria o compartilhamento.
void	create(FileRequestOptions options, OperationContext opContext) Cria o compartilhamento usando as opções especificadas e o contexto de operação.
String	createFilePermission(String permission) Cria uma permissão de arquivo.
String	createFilePermission(String permission, FileRequestOptions options, OperationContext opContext) Cria uma permissão de arquivo.
boolean	createIfNotExists() Cria o compartilhamento se ele não existir.
boolean	createIfNotExists(FileRequestOptions options, OperationContext opContext) Cria o compartilhamento se ele não existir, usando as opções de solicitação e o contexto de operação especificados.
final CloudFileShare	createSnapshot() Cria uma instantâneo do compartilhamento.
final CloudFileShare	createSnapshot(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Cria uma instantâneo do compartilhamento de arquivos usando as opções de solicitação e o contexto de operação especificados.
final CloudFileShare	createSnapshot(final HashMap<String, String> metadata, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Cria uma instantâneo do compartilhamento de arquivos usando as opções de solicitação especificadas e o contexto de operação.
void	delete() Exclui o compartilhamento.
void	delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Exclui o compartilhamento usando as opções de solicitação especificadas e o contexto de operação.
void	delete(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Exclui o compartilhamento usando as opções de instantâneo e solicitação especificadas e o contexto de operação. Um compartilhamento que tenha instantâneos não pode ser excluído, a menos que os instantâneos também sejam excluídos. Se um compartilhamento tiver instantâneos, use o INCLUDE_SNAPSHOTS valor no parâmetro para incluir os instantâneos ao excluir o compartilhamento base.
boolean	deleteIfExists() Exclui o compartilhamento se ele existir.
boolean	deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Exclui o compartilhamento se ele existir usando as opções de solicitação especificadas e o contexto de operação.
boolean	deleteIfExists(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Exclui o compartilhamento se ele existir, usando as opções de instantâneo e solicitação especificadas e o contexto de operação. Um compartilhamento que tenha instantâneos não pode ser excluído, a menos que os instantâneos também sejam excluídos. Se um compartilhamento tiver instantâneos, use o INCLUDE_SNAPSHOTS valor no parâmetro para incluir os instantâneos ao excluir o compartilhamento base.
void	downloadAttributes() Baixa os atributos do compartilhamento, que consistem em metadados e propriedades.
void	downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Baixa os atributos do compartilhamento, que consistem em metadados e propriedades, usando as opções de solicitação especificadas e o contexto de operação.
FileSharePermissions	downloadPermissions() Baixa as configurações de permissão para o compartilhamento.
FileSharePermissions	downloadPermissions(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Baixa as configurações de permissões para o compartilhamento usando as opções de solicitação especificadas e o contexto de operação.
boolean	exists() Retorna um valor que indica se o compartilhamento existe.
boolean	exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Retorna um valor que indica se o compartilhamento existe, usando as opções de solicitação especificadas e o contexto de operação.
String	generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier) Retorna uma assinatura de acesso compartilhado para o compartilhamento. Observe que isso não contém o "?".
String	generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols) Retorna uma assinatura de acesso compartilhado para o compartilhamento. Observe que isso não contém o "?".
String	getFilePermission(String filePermissionKey) Obtém a permissão de arquivo associada a uma chave de permissão de arquivo.
String	getFilePermission(String filePermissionKey, FileRequestOptions options, OperationContext opContext) Obtém a permissão de arquivo associada a uma chave de permissão de arquivo.
HashMap<String, String>	getMetadata() Retorna os metadados do compartilhamento. Esse valor é inicializado com os metadados do compartilhamento por uma chamada para downloadAttributes()e é definido no compartilhamento com uma chamada para uploadMetadata().
String	getName() Retorna o nome do compartilhamento.
FileShareProperties	getProperties() Retorna as propriedades do compartilhamento.
final URI	getQualifiedUri() Retorna o URI qualificado da assinatura de acesso compartilhado ou instantâneo para esse compartilhamento.
CloudFileDirectory	getRootDirectoryReference() Retorna uma referência a um CloudFileDirectory objeto que representa o diretório de arquivo raiz dentro desse compartilhamento.
CloudFileClient	getServiceClient() Retorna o cliente de serviço de arquivo associado a esse compartilhamento.
final String	getSnapshot() Retorna a snapshotID para este compartilhamento.
ShareStats	getStats() Consulta o serviço para o deste ShareStatscompartilhamento.
ShareStats	getStats(FileRequestOptions options, OperationContext opContext) Consulta o serviço para o deste ShareStatscompartilhamento.
StorageUri	getStorageUri() Retorna a lista de URIs para todos os locais.
URI	getUri() Retorna o URI desse compartilhamento.
final boolean	isSnapshot() Indica se esse compartilhamento é um instantâneo.
void	setMetadata(final HashMap<String, String> metadata) Define a coleção de metadados de pares nome-valor a ser definida no compartilhamento com uma uploadMetadata() chamada. Essa coleção substituirá todos os metadados de compartilhamento existentes. Se isso for definido como uma coleção vazia, os metadados de compartilhamento serão limpos em uma uploadMetadata() chamada.
void	setProperties(final FileShareProperties properties) Define as propriedades do compartilhamento.
void	uploadMetadata() Carrega os metadados do compartilhamento.
void	uploadMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Carrega os metadados do compartilhamento usando as opções de solicitação e o contexto de operação especificados.
void	uploadPermissions(final FileSharePermissions permissions) Carrega as permissões do compartilhamento.
void	uploadPermissions(final FileSharePermissions permissions, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Carrega as permissões do compartilhamento usando as opções de solicitação e o contexto de operação especificados.
final void	uploadProperties() Atualizações as propriedades do compartilhamento no serviço de armazenamento. Use downloadAttributes() para recuperar os valores mais recentes para as propriedades e metadados do compartilhamento do serviço de armazenamento do Microsoft Azure.
final void	uploadProperties(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Atualizações as propriedades do compartilhamento usando as opções de solicitação e o contexto de operação. Use downloadAttributes() para recuperar os valores mais recentes para as propriedades e metadados do compartilhamento do serviço de armazenamento do Microsoft Azure.

Detalhes do construtor

CloudFileShare

public CloudFileShare(final StorageUri storageUri)

Cria uma instância da classe usando o URI especificado.

Parameters:

storageUri - Um StorageUri objeto que representa o URI absoluto do compartilhamento.

Throws:

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

CloudFileShare

public CloudFileShare(final StorageUri storageUri, final StorageCredentials credentials)

Cria uma instância da classe usando o StorageUri e as credenciais especificados.

Parameters:

storageUri - Um StorageUri objeto que representa o StorageUri absoluto do compartilhamento.

credentials - Um StorageCredentials objeto usado para autenticar o acesso.

Throws:

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

CloudFileShare

public CloudFileShare(final String shareName, String snapshotID, final CloudFileClient client)

Cria uma instância da classe usando o nome e o cliente especificados.

Parameters:

shareName - Um String que representa 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 versão instantâneo, se aplicável.

client - Um CloudFileClient objeto que representa o cliente de serviço associado e que especifica o ponto de extremidade para o serviço File.

Throws:

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

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

CloudFileShare

public CloudFileShare(final URI uri)

Cria uma instância da classe usando o URI especificado.

Parameters:

uri - Um java.net.URI objeto que representa o URI absoluto do compartilhamento.

Throws:

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

CloudFileShare

public CloudFileShare(final URI uri, final StorageCredentials credentials)

Cria uma instância da classe usando o URI e as credenciais especificados.

Parameters:

uri - Um java.net.URI objeto que representa o URI absoluto do compartilhamento.

credentials - Um StorageCredentials objeto usado para autenticar o acesso.

Throws:

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

Detalhes do método

assertNoSnapshot

protected void assertNoSnapshot()

Afirma que o compartilhamento não é um instantâneo.

create

public void create()

Cria o compartilhamento.

Throws:

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

create

public void create(FileRequestOptions options, OperationContext opContext)

Cria o compartilhamento usando as opções especificadas e o contexto de operação.

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.

Throws:

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

createFilePermission

public String createFilePermission(String permission)

Cria uma permissão de arquivo.

Parameters:

permission - Um String objeto que representa a permissão de arquivo a ser criada.

Returns:

O String que representa a chave de permissão de arquivo associada à permissão de arquivo criada.

Throws:

StorageException

IOException

createFilePermission

public String createFilePermission(String permission, FileRequestOptions options, OperationContext opContext)

Cria uma permissão de arquivo.

Parameters:

permission - Um String objeto que representa a permissão de arquivo a ser criada.

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:

O String que representa a chave de permissão de arquivo associada à permissão de arquivo criada.

Throws:

StorageException

IOException

createIfNotExists

public boolean createIfNotExists()

Cria o compartilhamento se ele não existir.

Returns:

true se o contêiner ainda não existia e foi criado; caso contrário, false.

Throws:

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

createIfNotExists

public boolean createIfNotExists(FileRequestOptions options, OperationContext opContext)

Cria o compartilhamento se ele não existir, usando as opções de solicitação e o contexto de operação especificados.

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:

true se o contêiner ainda não existia e foi criado; caso contrário, false.

Throws:

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

createSnapshot

public final CloudFileShare createSnapshot()

Cria uma instantâneo do compartilhamento.

Returns:

Um CloudFileShare objeto que representa o instantâneo do compartilhamento.

Throws:

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

createSnapshot

public final CloudFileShare createSnapshot(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Cria uma instantâneo do compartilhamento de arquivos usando as opções de solicitação e o contexto de operação especificados.

Parameters:

accessCondition - Um AccessCondition objeto que representa as condições de acesso para o compartilhamento.

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 CloudFileShare objeto que representa o instantâneo do compartilhamento de arquivos.

Throws:

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

createSnapshot

public final CloudFileShare createSnapshot(final HashMap metadata, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Cria uma instantâneo do compartilhamento de arquivos usando as opções de solicitação especificadas e o contexto de operação.

Parameters:

metadata - Uma coleção de pares nome-valor que definem os metadados do instantâneo ou nulo.

accessCondition - Um AccessCondition objeto que representa as condições de acesso para o compartilhamento de arquivos.

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 CloudFileShare objeto que representa o instantâneo do compartilhamento de arquivos.

Throws:

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

delete

public void delete()

Exclui o compartilhamento.

Throws:

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

delete

public void delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Exclui o compartilhamento usando as opções de solicitação especificadas e o contexto de operação.

Parameters:

accessCondition - Um AccessCondition objeto que representa as condições de acesso para o compartilhamento.

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.

delete

public void delete(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Exclui o compartilhamento usando as opções de instantâneo e solicitação especificadas e o contexto de operação.

Um compartilhamento que tenha instantâneos não pode ser excluído, a menos que os instantâneos também sejam excluídos. Se um compartilhamento tiver instantâneos, use o INCLUDE_SNAPSHOTS valor no parâmetro para incluir os instantâneos ao excluir o compartilhamento base.

Parameters:

deleteSnapshotsOption - Um DeleteShareSnapshotsOption objeto que indica se é necessário excluir apenas instantâneos ou o compartilhamento e seus instantâneos.

accessCondition - Um AccessCondition objeto que representa as condições de acesso para o compartilhamento.

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.

deleteIfExists

public boolean deleteIfExists()

Exclui o compartilhamento se ele existir.

Returns:

true se o compartilhamento existia e foi excluído; caso contrário, false.

Throws:

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

deleteIfExists

public boolean deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Exclui o compartilhamento se ele existir usando as opções de solicitação especificadas e o contexto de operação.

Parameters:

accessCondition - Um AccessCondition objeto que representa as condições de acesso para o compartilhamento.

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:

true se o compartilhamento existia e foi excluído; caso contrário, false.

Throws:

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

deleteIfExists

public boolean deleteIfExists(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Exclui o compartilhamento se ele existir, usando as opções de instantâneo e solicitação especificadas e o contexto de operação.

Um compartilhamento que tenha instantâneos não pode ser excluído, a menos que os instantâneos também sejam excluídos. Se um compartilhamento tiver instantâneos, use o INCLUDE_SNAPSHOTS valor no parâmetro para incluir os instantâneos ao excluir o compartilhamento base.

Parameters:

deleteSnapshotsOption - Um DeleteShareSnapshotsOption objeto que indica se é necessário excluir apenas instantâneos ou o compartilhamento e seus instantâneos.

accessCondition - Um AccessCondition objeto que representa as condições de acesso para o compartilhamento.

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:

true se o compartilhamento existia e foi excluído; caso contrário, false.

Throws:

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

downloadAttributes

public void downloadAttributes()

Baixa os atributos do compartilhamento, que consistem em metadados e propriedades.

Throws:

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

downloadAttributes

public void downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Baixa os atributos do compartilhamento, que consistem em metadados e propriedades, usando as opções de solicitação especificadas e o contexto de operação.

Parameters:

accessCondition - Um AccessCondition objeto que representa as condições de acesso para o compartilhamento.

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.

downloadPermissions

public FileSharePermissions downloadPermissions()

Baixa as configurações de permissão para o compartilhamento.

Returns:

Um FileSharePermissions objeto que representa as permissões do compartilhamento.

Throws:

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

downloadPermissions

public FileSharePermissions downloadPermissions(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Baixa as configurações de permissões para o compartilhamento usando as opções de solicitação especificadas e o contexto de operação.

Parameters:

accessCondition - Um AccessCondition objeto que representa as condições de acesso para o compartilhamento.

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 FileSharePermissions objeto que representa as permissões do compartilhamento.

Throws:

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

exists

public boolean exists()

Retorna um valor que indica se o compartilhamento existe.

Returns:

true se o compartilhamento existir, caso contrário false, .

Throws:

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

exists

public boolean exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Retorna um valor que indica se o compartilhamento existe, usando as opções de solicitação especificadas e o contexto de operação.

Parameters:

accessCondition - Um AccessCondition objeto que representa as condições de acesso para o compartilhamento.

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:

true se o compartilhamento existir, caso contrário false, .

Throws:

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

generateSharedAccessSignature

public String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier)

Retorna uma assinatura de acesso compartilhado para o compartilhamento. Observe que isso não contém o "?".

Parameters:

policy - Um SharedAccessFilePolicy objeto que representa a política de acesso para a assinatura de acesso compartilhado.

groupPolicyIdentifier - Um String que representa a política de acesso no nível do compartilhamento.

Returns:

Um String que representa uma assinatura de acesso compartilhado para o compartilhamento.

Throws:

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

InvalidKeyException - Se a chave for inválida.

generateSharedAccessSignature

public String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)

Retorna uma assinatura de acesso compartilhado para o compartilhamento. Observe que isso não contém o "?".

Parameters:

policy - Um SharedAccessFilePolicy objeto que representa a política de acesso para a assinatura de acesso compartilhado.

groupPolicyIdentifier - Um String que representa a política de acesso no nível do compartilhamento.

ipRange - Um IPRange objeto que contém o intervalo de endereços IP permitidos.

protocols - Um SharedAccessProtocols que representa os protocolos de Internet permitidos.

Returns:

Um String que representa uma assinatura de acesso compartilhado para o compartilhamento.

Throws:

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

InvalidKeyException - Se a chave for inválida.

getFilePermission

public String getFilePermission(String filePermissionKey)

Obtém a permissão de arquivo associada a uma chave de permissão de arquivo.

Parameters:

filePermissionKey - Um String objeto que representa a chave de permissão de arquivo.

Returns:

O String que representa a permissão de arquivo associada à chave de permissão de arquivo.

Throws:

StorageException

getFilePermission

public String getFilePermission(String filePermissionKey, FileRequestOptions options, OperationContext opContext)

Obtém a permissão de arquivo associada a uma chave de permissão de arquivo.

Parameters:

filePermissionKey - Um String objeto que representa a chave de permissão de arquivo.

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:

O String que representa a permissão de arquivo associada à chave de permissão de arquivo.

Throws:

StorageException

getMetadata

public HashMap getMetadata()

Retorna os metadados do compartilhamento. Esse valor é inicializado com os metadados do compartilhamento por uma chamada para downloadAttributes()e é definido no compartilhamento com uma chamada para uploadMetadata().

Returns:

Um java.util.HashMap objeto que representa os metadados do compartilhamento.

getName

public String getName()

Retorna o nome do compartilhamento.

Returns:

Um String que representa o nome do compartilhamento.

getProperties

public FileShareProperties getProperties()

Retorna as propriedades do compartilhamento.

Returns:

Um FileShareProperties objeto que representa as propriedades do compartilhamento.

getQualifiedUri

public final URI getQualifiedUri()

Retorna o URI qualificado da assinatura de acesso compartilhado ou instantâneo para esse compartilhamento.

Returns:

Um java.net.URI objeto que representa o instantâneo ou a assinatura de acesso compartilhado.

Throws:

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

URISyntaxException - Se o URI do recurso for inválido.

getRootDirectoryReference

public CloudFileDirectory getRootDirectoryReference()

Retorna uma referência a um CloudFileDirectory objeto que representa o diretório de arquivo raiz dentro desse compartilhamento.

Returns:

Uma CloudFileDirectory referência ao diretório raiz para esse compartilhamento.

Throws:

StorageException

URISyntaxException

getServiceClient

public CloudFileClient getServiceClient()

Retorna o cliente de serviço de arquivo associado a esse compartilhamento.

Returns:

Um CloudFileClient objeto que representa o cliente de serviço associado a esse compartilhamento.

getSnapshot

public final String getSnapshot()

Retorna a snapshotID para este compartilhamento.

Returns:

O snapshotID como uma cadeia de caracteres para esse compartilhamento.

getStats

public ShareStats getStats()

Consulta o serviço para o deste ShareStatscompartilhamento.

Returns:

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

Throws:

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

getStats

public ShareStats getStats(FileRequestOptions options, OperationContext opContext)

Consulta o serviço para o deste ShareStatscompartilhamento.

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 ShareStats objeto para o serviço de armazenamento fornecido.

Throws:

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

getStorageUri

public StorageUri getStorageUri()

Retorna a lista de URIs para todos os locais.

Returns:

Um StorageUri objeto que representa a lista de URIs para todos os locais.

getUri

public URI getUri()

Retorna o URI desse compartilhamento.

Returns:

A URI absoluta para o compartilhamento.

isSnapshot

public final boolean isSnapshot()

Indica se esse compartilhamento é um instantâneo.

Returns:

truese o compartilhamento for um instantâneo, caso contráriofalse, .

setMetadata

public void setMetadata(final HashMap metadata)

Define a coleção de metadados de pares nome-valor a ser definida no compartilhamento com uma uploadMetadata() chamada. Essa coleção substituirá todos os metadados de compartilhamento existentes. Se isso for definido como uma coleção vazia, os metadados de compartilhamento serão limpos em uma uploadMetadata() chamada.

Parameters:

metadata - Um java.util.HashMap objeto que representa os metadados que estão sendo atribuídos ao compartilhamento.

setProperties

public void setProperties(final FileShareProperties properties)

Define as propriedades do compartilhamento.

Parameters:

properties - Um FileShareProperties objeto que representa as propriedades que estão sendo atribuídas ao compartilhamento.

uploadMetadata

public void uploadMetadata()

Carrega os metadados do compartilhamento.

Throws:

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

uploadMetadata

public void uploadMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Carrega os metadados do compartilhamento usando as opções de solicitação e o contexto de operação especificados.

Parameters:

accessCondition - Um AccessCondition objeto que representa as condições de acesso para o compartilhamento.

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.

Throws:

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

uploadPermissions

public void uploadPermissions(final FileSharePermissions permissions)

Carrega as permissões do compartilhamento.

Parameters:

permissions - Um FileSharePermissions objeto que representa as permissões para carregar.

Throws:

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

uploadPermissions

public void uploadPermissions(final FileSharePermissions permissions, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Carrega as permissões do compartilhamento usando as opções de solicitação e o contexto de operação especificados.

Parameters:

permissions - Um FileSharePermissions objeto que representa as permissões para carregar.

accessCondition - Um AccessCondition objeto que representa as condições de acesso para o compartilhamento.

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.

Throws:

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

uploadProperties

public final void uploadProperties()

Atualizações as propriedades do compartilhamento no serviço de armazenamento.

Use downloadAttributes() para recuperar os valores mais recentes para as propriedades e metadados do compartilhamento do serviço de armazenamento do Microsoft Azure.

Throws:

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

uploadProperties

public final void uploadProperties(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Atualizações as propriedades do compartilhamento usando as opções de solicitação e o contexto de operação.

Use downloadAttributes() para recuperar os valores mais recentes para as propriedades e metadados do compartilhamento do serviço de armazenamento do Microsoft Azure.

Parameters:

accessCondition - Um AccessCondition objeto que representa as condições de acesso para o compartilhamento.

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.

Throws:

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