CloudFileDirectory Classe
- java.
lang. Object - ListFileItem
- com.
microsoft. azure. storage. file. CloudFileDirectory
- com.
public class CloudFileDirectory implements ListFileItem
Representa um diretório virtual de arquivos.
Os diretórios, que são encapsulados como CloudFileDirectory objetos, mantêm arquivos e também podem conter subdiretórios.
Resumo do Construtor
Construtor | Description |
---|---|
CloudFileDirectory(final StorageUri directoryAbsoluteUri) |
Cria uma instância da classe usando um URI absoluto para o diretório. |
CloudFileDirectory(final StorageUri directoryAbsoluteUri, final StorageCredentials credentials) |
Cria uma instância da classe usando um URI absoluto para o diretório e as credenciais. |
CloudFileDirectory(final StorageUri uri, final String directoryName, final CloudFileShare share) |
Cria uma instância da classe usando o endereço, o compartilhamento e o cliente especificados. |
CloudFileDirectory(final URI directoryAbsoluteUri) |
Cria uma instância da classe usando um URI absoluto para o diretório. |
CloudFileDirectory(final URI directoryAbsoluteUri, final StorageCredentials credentials) |
Cria uma instância da classe usando um URI absoluto para o diretório e as credenciais. |
Resumo do método
Modificador e tipo | Método e descrição |
---|---|
void |
assertValidFilePermissionOrKey()
Verifica se filePermission e properties.filePermissionKey do diretório não estão definidos. |
Result |
closeAllHandlesSegmented()
Feche todos os identificadores SMB neste arquivo. |
Result |
closeAllHandlesSegmented(final ResultContinuation continuationToken, boolean recursive, FileRequestOptions options, OperationContext opContext)
Feche todos os identificadores SMB neste arquivo. |
Result |
closeHandleSegmented(String handleID)
Feche todos os identificadores SMB neste arquivo. |
Result |
closeHandleSegmented(String handleID, ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)
Feche todos os identificadores SMB neste arquivo. |
void |
create()
Cria um diretório. |
void |
create(FileRequestOptions options, OperationContext opContext)
Cria o diretório usando as opções especificadas e o contexto de operação. |
boolean |
createIfNotExists()
Cria o diretório se ele não existir. |
boolean |
createIfNotExists(FileRequestOptions options, OperationContext opContext)
Cria o diretório se ele não existir, usando as opções de solicitação e o contexto de operação especificados. |
void |
delete()
Exclui o diretório. |
void |
delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Exclui o diretório usando as opções de solicitação e o contexto de operação especificados. |
boolean |
deleteIfExists()
Exclui o diretório se ele existir. |
boolean |
deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Exclui o diretório se ele existir usando as opções de solicitação e o contexto de operação especificados. |
void |
downloadAttributes()
Baixa as propriedades do diretório. |
void |
downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Baixa as propriedades do diretório usando as opções de solicitação especificadas e o contexto de operação. |
boolean |
exists()
Retorna um valor que indica se o diretório existe. |
boolean |
exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Retorna um valor que indica se o diretório existe, usando as opções de solicitação especificadas e o contexto de operação. |
Cloud |
getDirectoryReference(final String itemName)
Retorna uma referência a um CloudFileDirectory objeto que representa um diretório neste diretório. |
Cloud |
getFileReference(final String fileName)
Retorna uma referência a um CloudFile objeto que representa um arquivo neste diretório. |
HashMap<String, String> |
getMetadata()
Retorna os metadados do diretório. Esse valor é inicializado com os metadados do diretório por uma chamada para downloadAttributes()e é definido no diretório com uma chamada para uploadMetadata(). |
String |
getName()
Retorna o nome desse diretório. |
Cloud |
getParent()
Retorna o CloudFileDirectory diretório pai associado a esse diretório. |
File |
getProperties()
Retorna o FileDirectoryProperties objeto que contém as propriedades do sistema do diretório. |
Cloud |
getServiceClient()
Retorna o cliente do serviço de arquivo associado a esse diretório. |
Cloud |
getShare()
Retorna o compartilhamento para este diretório. |
final Storage |
getStorageUri()
Retorna a lista de URIs para todos os locais. |
URI |
getUri()
Retorna o URI para este diretório. |
Iterable<List |
listFilesAndDirectories()
Retorna uma coleção enumerável de itens de arquivo e diretório para o diretório. |
Iterable<List |
listFilesAndDirectories(FileRequestOptions options, OperationContext opContext)
Retorna uma coleção enumerável de itens de arquivo e diretório para o diretório. |
Iterable<List |
listFilesAndDirectories(String prefix, FileRequestOptions options, OperationContext opContext)
Retorna uma coleção enumerável de itens de arquivo e diretório para o diretório. |
Result |
listFilesAndDirectoriesSegmented()
Retorna um segmento de resultado de uma coleção enumerável de arquivos e diretórios para este cliente de serviço de arquivo. |
Result |
listFilesAndDirectoriesSegmented(final Integer maxResults, final ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)
Retorna um segmento de resultado de uma coleção enumerável de arquivos e diretórios para esse diretório, usando as opções de detalhes de listagem especificadas, opções de solicitação e contexto de operação. |
Result |
listFilesAndDirectoriesSegmented(final String prefix, final Integer maxResults, final ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)
Retorna um segmento de resultado de uma coleção enumerável de arquivos e diretórios para esse diretório, usando as opções de detalhes de listagem especificadas, opções de solicitação e contexto de operação. |
Iterable<File |
listHandles()
Obtém os identificadores SMB abertos neste arquivo. |
Iterable<File |
listHandles(boolean recursive, FileRequestOptions options, OperationContext opContext)
Obtém os identificadores SMB abertos neste arquivo. |
Result |
listHandlesSegmented()
Obtém os identificadores SMB abertos neste arquivo. |
Result |
listHandlesSegmented(final Integer maxResults, final boolean recursive, final ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)
Obtém os identificadores SMB abertos neste arquivo. |
void |
setFilePermission(String filePermission)
Define a permissão de arquivo do diretório |
void |
setMetadata(HashMap<String, String> metadata)
Define a coleção de metadados de pares nome-valor a ser definida no diretório com uma uploadMetadata() chamada. Essa coleção substituirá todos os metadados de diretório existentes. Se isso for definido como uma coleção vazia, os metadados do diretório serão limpos em uma uploadMetadata() chamada. |
final void |
setProperties(final FileDirectoryProperties properties)
Define as propriedades do diretório. |
final void |
setShare(final CloudFileShare share)
Define o compartilhamento para o diretório. |
void |
setStorageUri(final StorageUri storageUri)
Define a lista de URIs para todos os locais. |
void |
uploadMetadata()
Carrega os metadados do diretório. |
void |
uploadMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Carrega os metadados do diretório usando as opções de solicitação e o contexto de operação especificados. |
final void |
uploadProperties()
Carrega as propriedades do diretório para o serviço de armazenamento. Use downloadAttributes() para recuperar os valores mais recentes para as propriedades e metadados do diretório do serviço de armazenamento do Microsoft Azure. |
final void |
uploadProperties(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Carrega as propriedades do diretório usando a condição de acesso, 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 diretório do serviço de armazenamento do Microsoft Azure. |
Detalhes do construtor
CloudFileDirectory
public CloudFileDirectory(final StorageUri directoryAbsoluteUri)
Cria uma instância da classe usando um URI absoluto para o diretório.
Parameters:
Throws:
CloudFileDirectory
public CloudFileDirectory(final StorageUri directoryAbsoluteUri, final StorageCredentials credentials)
Cria uma instância da classe usando um URI absoluto para o diretório e as credenciais.
Parameters:
Throws:
CloudFileDirectory
protected CloudFileDirectory(final StorageUri uri, final String directoryName, final CloudFileShare share)
Cria uma instância da classe usando o endereço, o compartilhamento e o cliente especificados.
Parameters:
String
que representa o nome do diretório.
CloudFileDirectory
public CloudFileDirectory(final URI directoryAbsoluteUri)
Cria uma instância da classe usando um URI absoluto para o diretório.
Parameters:
Throws:
CloudFileDirectory
public CloudFileDirectory(final URI directoryAbsoluteUri, final StorageCredentials credentials)
Cria uma instância da classe usando um URI absoluto para o diretório e as credenciais.
Parameters:
Throws:
Detalhes do método
assertValidFilePermissionOrKey
protected void assertValidFilePermissionOrKey()
Verifica se filePermission e properties.filePermissionKey do diretório não estão definidos.
closeAllHandlesSegmented
public ResultSegment
Feche todos os identificadores SMB neste arquivo.
Returns:
Throws:
closeAllHandlesSegmented
public ResultSegment
Feche todos os identificadores SMB neste arquivo.
Parameters:
null
usará as opções de solicitação padrão do cliente de serviço associado ( CloudFileClient).
Returns:
Throws:
closeHandleSegmented
public ResultSegment
Feche todos os identificadores SMB neste arquivo.
Parameters:
Returns:
Throws:
closeHandleSegmented
public ResultSegment
Feche todos os identificadores SMB neste arquivo.
Parameters:
null
usará as opções de solicitação padrão do cliente de serviço associado ( CloudFileClient).
Returns:
Throws:
create
public void create()
Cria um diretório.
Throws:
create
public void create(FileRequestOptions options, OperationContext opContext)
Cria o diretório usando as opções especificadas e o contexto de operação.
Parameters:
null
usará as opções de solicitação padrão do cliente de serviço associado ( CloudFileClient).
Throws:
createIfNotExists
public boolean createIfNotExists()
Cria o diretório se ele não existir.
Returns:
true
se o diretório ainda não existia e foi criado; caso contrário, false
.
Throws:
createIfNotExists
public boolean createIfNotExists(FileRequestOptions options, OperationContext opContext)
Cria o diretório se ele não existir, usando as opções de solicitação e o contexto de operação especificados.
Parameters:
null
usará as opções de solicitação padrão do cliente de serviço associado (CloudFileClient).
Returns:
true
se o diretório ainda não existia e foi criado; caso contrário, false
.
Throws:
delete
public void delete()
Exclui o diretório.
Throws:
delete
public void delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Exclui o diretório usando as opções de solicitação e o contexto de operação especificados.
Parameters:
null
usará as opções de solicitação padrão do cliente de serviço associado ( CloudFileClient).
Throws:
deleteIfExists
public boolean deleteIfExists()
Exclui o diretório se ele existir.
Returns:
true
se o diretório ainda não existia e foi criado; caso contrário, false
.
Throws:
deleteIfExists
public boolean deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Exclui o diretório se ele existir usando as opções de solicitação e o contexto de operação especificados.
Parameters:
null
usará as opções de solicitação padrão do cliente de serviço associado ( CloudFileClient).
Returns:
true
se o diretório existia e foi excluído; caso contrário, false
.
Throws:
downloadAttributes
public void downloadAttributes()
Baixa as propriedades do diretório.
Throws:
downloadAttributes
public void downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Baixa as propriedades do diretório usando as opções de solicitação especificadas e o contexto de operação.
Parameters:
null
usará as opções de solicitação padrão do cliente de serviço associado ( CloudFileClient).
Throws:
exists
public boolean exists()
Retorna um valor que indica se o diretório existe.
Returns:
true
se o diretório existir, caso contrário false
, .
Throws:
exists
public boolean exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Retorna um valor que indica se o diretório existe, usando as opções de solicitação especificadas e o contexto de operação.
Parameters:
null
usará as opções de solicitação padrão do cliente de serviço associado ( CloudFileClient).
Returns:
true
se o diretório existir, caso contrário false
, .
Throws:
getDirectoryReference
public CloudFileDirectory getDirectoryReference(final String itemName)
Retorna uma referência a um CloudFileDirectory objeto que representa um diretório neste diretório.
Parameters:
String
que representa o nome do diretório.
Returns:
Throws:
getFileReference
public CloudFile getFileReference(final String fileName)
Retorna uma referência a um CloudFile objeto que representa um arquivo neste diretório.
Parameters:
String
que representa o nome do arquivo.
Returns:
Throws:
getMetadata
public HashMap
Retorna os metadados do diretório. Esse valor é inicializado com os metadados do diretório por uma chamada para downloadAttributes()e é definido no diretório com uma chamada para uploadMetadata().
Returns:
java.util.HashMap
objeto que representa os metadados do diretório.getName
public String getName()
Retorna o nome desse diretório.
Returns:
String
que representa o nome do diretório.getParent
public CloudFileDirectory getParent()
Retorna o CloudFileDirectory diretório pai associado a esse diretório.
Overrides:
CloudFileDirectory.getParent()Returns:
Throws:
getProperties
public FileDirectoryProperties getProperties()
Retorna o FileDirectoryProperties objeto que contém as propriedades do sistema do diretório.
Returns:
getServiceClient
public CloudFileClient getServiceClient()
Retorna o cliente do serviço de arquivo associado a esse diretório.
Returns:
getShare
public CloudFileShare getShare()
Retorna o compartilhamento para este diretório.
Overrides:
CloudFileDirectory.getShare()Returns:
Throws:
getStorageUri
public final StorageUri getStorageUri()
Retorna a lista de URIs para todos os locais.
Overrides:
CloudFileDirectory.getStorageUri()Returns:
getUri
public URI getUri()
Retorna o URI para este diretório.
Overrides:
CloudFileDirectory.getUri()Returns:
java.net.URI
objeto que representa o URI para esse diretório.listFilesAndDirectories
public Iterable
Retorna uma coleção enumerável de itens de arquivo e diretório para o diretório.
Returns:
listFilesAndDirectories
public Iterable
Retorna uma coleção enumerável de itens de arquivo e diretório para o diretório.
Parameters:
null
usará as opções de solicitação padrão do cliente de serviço associado ( CloudFileClient).
Returns:
listFilesAndDirectories
public Iterable
Retorna uma coleção enumerável de itens de arquivo e diretório para o diretório.
Parameters:
null
usará as opções de solicitação padrão do cliente de serviço associado ( CloudFileClient).
Returns:
listFilesAndDirectoriesSegmented
public ResultSegment
Retorna um segmento de resultado de uma coleção enumerável de arquivos e diretórios para este cliente de serviço de arquivo.
Returns:
Throws:
listFilesAndDirectoriesSegmented
public ResultSegment
Retorna um segmento de resultado de uma coleção enumerável de arquivos e diretórios para esse diretório, usando as opções de detalhes de listagem especificadas, opções de solicitação e contexto de operação.
Parameters:
null
ou maior que 5000, o servidor retornará até 5.000 itens. Deve ser pelo menos 1.
null
usará as opções de solicitação padrão do cliente de serviço associado ( CloudFileClient).
Returns:
Throws:
listFilesAndDirectoriesSegmented
public ResultSegment
Retorna um segmento de resultado de uma coleção enumerável de arquivos e diretórios para esse diretório, usando as opções de detalhes de listagem especificadas, opções de solicitação e contexto de operação.
Parameters:
null
ou maior que 5000, o servidor retornará até 5.000 itens. Deve ser pelo menos 1.
null
usará as opções de solicitação padrão do cliente de serviço associado ( CloudFileClient).
Returns:
Throws:
listHandles
public Iterable
Obtém os identificadores SMB abertos neste arquivo.
Returns:
Umiterável
</code> of the handles that will lazily request new segments. </p>
listHandles
public Iterable listHandles(boolean recursive, FileRequestOptions options, OperationContext opContext)
Obtém os identificadores SMB abertos neste arquivo.
Parameters:
recursive
- Especifica se a operação deve ser aplicada ao diretório especificado no URI, seus arquivos, seus subdiretórios e seus arquivos.
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 OperationContext objeto 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:
Umiterável
</code> of the handles that will lazily request new segments. </p>
listHandlesSegmented
public ResultSegment listHandlesSegmented()
Obtém os identificadores SMB abertos neste arquivo.
Returns:
Um ResultSegment<T> objeto que contém um segmento da coleção enumerável de ListFileItem objetos que representam os arquivos e diretórios.
Throws:
StorageException
listHandlesSegmented
public ResultSegment listHandlesSegmented(final Integer maxResults, final boolean recursive, final ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)
Obtém os identificadores SMB abertos neste arquivo.
Parameters:
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.
recursive
- Especifica se a operação deve ser aplicada ao diretório especificado no URI, seus arquivos, seus subdiretórios e seus arquivos.
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. Especificar null
usará as opções de solicitação padrão do cliente de serviço associado ( CloudFileClient).
opContext
- Um OperationContext objeto 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 ListFileItem objetos que representam os arquivos e diretórios.
Throws:
StorageException
setFilePermission
public void setFilePermission(String filePermission)
Define a permissão de arquivo do diretório
Parameters:
filePermission
- Um String
que representa a permissão de arquivo do diretório.
setMetadata
public void setMetadata(HashMap metadata)
Define a coleção de metadados de pares nome-valor a ser definida no diretório com uma uploadMetadata() chamada. Essa coleção substituirá todos os metadados de diretório existentes. Se isso for definido como uma coleção vazia, os metadados do diretório 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 diretório.
setProperties
protected final void setProperties(final FileDirectoryProperties properties)
Define as propriedades do diretório.
Parameters:
properties
- Um FileDirectoryProperties objeto que representa as propriedades que estão sendo atribuídas ao diretório.
setShare
protected final void setShare(final CloudFileShare share)
Define o compartilhamento para o diretório.
Parameters:
share
- Um CloudFileShare objeto que representa o compartilhamento que está sendo atribuído ao diretório.
setStorageUri
protected void setStorageUri(final StorageUri storageUri)
Define a lista de URIs para todos os locais.
Parameters:
storageUri
- Um StorageUri que representa a lista de URIs para todos os locais.
uploadMetadata
public void uploadMetadata()
Carrega os metadados do diretório.
Throws:
StorageException
- Se ocorreu um erro de serviço de armazenamento.
URISyntaxException
uploadMetadata
public void uploadMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Carrega os metadados do diretório 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 diretório.
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.
URISyntaxException
uploadProperties
public final void uploadProperties()
Carrega as propriedades do diretório para o serviço de armazenamento.
Use downloadAttributes() para recuperar os valores mais recentes para as propriedades e metadados do diretório do serviço de armazenamento do Microsoft Azure.
Throws:
StorageException
- Se ocorreu um erro de serviço de armazenamento.
URISyntaxException
uploadProperties
public final void uploadProperties(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Carrega as propriedades do diretório usando a condição de acesso, 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 diretório do serviço de armazenamento do Microsoft Azure.
Parameters:
accessCondition
- Um AccessCondition objeto que representa as condições de acesso para o diretório.
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.
URISyntaxException
Aplica-se a
Azure SDK for Java