CloudFileDirectory Clase
- java.
lang. Object - ListFileItem
- com.
microsoft. azure. storage. file. CloudFileDirectory
- com.
public class CloudFileDirectory implements ListFileItem
Representa un directorio virtual de archivos.
Directorios, que se encapsulan como CloudFileDirectory objetos, contienen archivos y también pueden contener subdirectorios.
Resumen del constructor
Constructor | Description |
---|---|
CloudFileDirectory(final StorageUri directoryAbsoluteUri) |
Crea una instancia de la clase mediante un URI absoluto en el directorio. |
CloudFileDirectory(final StorageUri directoryAbsoluteUri, final StorageCredentials credentials) |
Crea una instancia de la clase mediante un URI absoluto para el directorio y las credenciales. |
CloudFileDirectory(final StorageUri uri, final String directoryName, final CloudFileShare share) |
Crea una instancia de la clase mediante la dirección, el recurso compartido y el cliente especificados. |
CloudFileDirectory(final URI directoryAbsoluteUri) |
Crea una instancia de la clase mediante un URI absoluto en el directorio. |
CloudFileDirectory(final URI directoryAbsoluteUri, final StorageCredentials credentials) |
Crea una instancia de la clase mediante un URI absoluto para el directorio y las credenciales. |
Resumen del método
Modificador y tipo | Método y descripción |
---|---|
void |
assertValidFilePermissionOrKey()
Comprueba que el archivo del directorioPermission y properties.filePermissionKey no están establecidos. |
Result |
closeAllHandlesSegmented()
Cierre todos los identificadores de SMB en este archivo. |
Result |
closeAllHandlesSegmented(final ResultContinuation continuationToken, boolean recursive, FileRequestOptions options, OperationContext opContext)
Cierre todos los identificadores de SMB en este archivo. |
Result |
closeHandleSegmented(String handleID)
Cierre todos los identificadores de SMB en este archivo. |
Result |
closeHandleSegmented(String handleID, ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)
Cierre todos los identificadores de SMB en este archivo. |
void |
create()
Crea el directorio. |
void |
create(FileRequestOptions options, OperationContext opContext)
Crea el directorio con las opciones y el contexto de operación especificados. |
boolean |
createIfNotExists()
Crea el directorio si no existe. |
boolean |
createIfNotExists(FileRequestOptions options, OperationContext opContext)
Crea el directorio si no existe, con las opciones de solicitud y el contexto de operación especificados. |
void |
delete()
Elimina el directorio. |
void |
delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Elimina el directorio mediante las opciones de solicitud y el contexto de operación especificados. |
boolean |
deleteIfExists()
Elimina el directorio si existe. |
boolean |
deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Elimina el directorio si existe mediante las opciones de solicitud y el contexto de operación especificados. |
void |
downloadAttributes()
Descarga las propiedades del directorio. |
void |
downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Descarga las propiedades del directorio mediante las opciones de solicitud y el contexto de operación especificados. |
boolean |
exists()
Devuelve un valor que indica si el directorio existe. |
boolean |
exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Devuelve un valor que indica si el directorio existe, utilizando las opciones de solicitud y el contexto de operación especificados. |
Cloud |
getDirectoryReference(final String itemName)
Devuelve una referencia a un CloudFileDirectory objeto que representa un directorio de este directorio. |
Cloud |
getFileReference(final String fileName)
Devuelve una referencia a un CloudFile objeto que representa un archivo en este directorio. |
HashMap<String, String> |
getMetadata()
Devuelve los metadatos del directorio. Este valor se inicializa con los metadatos del directorio mediante una llamada a downloadAttributes()y se establece en el directorio con una llamada a uploadMetadata(). |
String |
getName()
Devuelve el nombre de este directorio. |
Cloud |
getParent()
Devuelve el CloudFileDirectory directorio primario asociado a este directorio. |
File |
getProperties()
Devuelve el FileDirectoryProperties objeto que contiene las propiedades del sistema del directorio. |
Cloud |
getServiceClient()
Devuelve el cliente del servicio de archivos asociado a este directorio. |
Cloud |
getShare()
Devuelve el recurso compartido de este directorio. |
final Storage |
getStorageUri()
Devuelve la lista de URI para todas las ubicaciones. |
URI |
getUri()
Devuelve el URI de este directorio. |
Iterable<List |
listFilesAndDirectories()
Devuelve una colección enumerable de elementos de archivo y directorio para el directorio. |
Iterable<List |
listFilesAndDirectories(FileRequestOptions options, OperationContext opContext)
Devuelve una colección enumerable de elementos de archivo y directorio para el directorio. |
Iterable<List |
listFilesAndDirectories(String prefix, FileRequestOptions options, OperationContext opContext)
Devuelve una colección enumerable de elementos de archivo y directorio para el directorio. |
Result |
listFilesAndDirectoriesSegmented()
Devuelve un segmento de resultado de una colección enumerable de archivos y directorios para este cliente de servicio de archivos. |
Result |
listFilesAndDirectoriesSegmented(final Integer maxResults, final ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)
Devuelve un segmento de resultado de una colección enumerable de archivos y directorios para este directorio, utilizando las opciones de detalles de la lista especificadas, las opciones de solicitud y el contexto de la operación. |
Result |
listFilesAndDirectoriesSegmented(final String prefix, final Integer maxResults, final ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)
Devuelve un segmento de resultado de una colección enumerable de archivos y directorios para este directorio, utilizando las opciones de detalles de la lista especificadas, las opciones de solicitud y el contexto de la operación. |
Iterable<File |
listHandles()
Obtiene los identificadores SMB abiertos en este archivo. |
Iterable<File |
listHandles(boolean recursive, FileRequestOptions options, OperationContext opContext)
Obtiene los identificadores SMB abiertos en este archivo. |
Result |
listHandlesSegmented()
Obtiene los identificadores SMB abiertos en este archivo. |
Result |
listHandlesSegmented(final Integer maxResults, final boolean recursive, final ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)
Obtiene los identificadores SMB abiertos en este archivo. |
void |
setFilePermission(String filePermission)
Establece el permiso de archivo del directorio |
void |
setMetadata(HashMap<String, String> metadata)
Establece la colección de metadatos de pares nombre-valor que se van a establecer en el directorio con una uploadMetadata() llamada. Esta colección sobrescribirá los metadatos de directorio existentes. Si se establece en una colección vacía, los metadatos del directorio se borrarán en una uploadMetadata() llamada. |
final void |
setProperties(final FileDirectoryProperties properties)
Establece las propiedades del directorio. |
final void |
setShare(final CloudFileShare share)
Establece el recurso compartido para el directorio. |
void |
setStorageUri(final StorageUri storageUri)
Establece la lista de URI para todas las ubicaciones. |
void |
uploadMetadata()
Carga los metadatos del directorio. |
void |
uploadMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Carga los metadatos del directorio mediante las opciones de solicitud y el contexto de operación especificados. |
final void |
uploadProperties()
Carga las propiedades del directorio en el servicio de almacenamiento. Use downloadAttributes() para recuperar los valores más recientes de las propiedades y metadatos del directorio del servicio de almacenamiento de Microsoft Azure. |
final void |
uploadProperties(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Carga las propiedades del directorio mediante la condición de acceso, las opciones de solicitud y el contexto de la operación. Use downloadAttributes() para recuperar los valores más recientes de las propiedades y metadatos del directorio del servicio de almacenamiento de Microsoft Azure. |
Detalles del constructor
CloudFileDirectory
public CloudFileDirectory(final StorageUri directoryAbsoluteUri)
Crea una instancia de la clase mediante un URI absoluto en el directorio.
Parameters:
Throws:
CloudFileDirectory
public CloudFileDirectory(final StorageUri directoryAbsoluteUri, final StorageCredentials credentials)
Crea una instancia de la clase mediante un URI absoluto para el directorio y las credenciales.
Parameters:
Throws:
CloudFileDirectory
protected CloudFileDirectory(final StorageUri uri, final String directoryName, final CloudFileShare share)
Crea una instancia de la clase mediante la dirección, el recurso compartido y el cliente especificados.
Parameters:
String
representa el nombre del directorio.
CloudFileDirectory
public CloudFileDirectory(final URI directoryAbsoluteUri)
Crea una instancia de la clase mediante un URI absoluto en el directorio.
Parameters:
Throws:
CloudFileDirectory
public CloudFileDirectory(final URI directoryAbsoluteUri, final StorageCredentials credentials)
Crea una instancia de la clase mediante un URI absoluto para el directorio y las credenciales.
Parameters:
Throws:
Detalles del método
assertValidFilePermissionOrKey
protected void assertValidFilePermissionOrKey()
Comprueba que el archivo del directorioPermission y properties.filePermissionKey no están establecidos.
closeAllHandlesSegmented
public ResultSegment
Cierre todos los identificadores de SMB en este archivo.
Returns:
Throws:
closeAllHandlesSegmented
public ResultSegment
Cierre todos los identificadores de SMB en este archivo.
Parameters:
null
, se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudFileClient).
Returns:
Throws:
closeHandleSegmented
public ResultSegment
Cierre todos los identificadores de SMB en este archivo.
Parameters:
Returns:
Throws:
closeHandleSegmented
public ResultSegment
Cierre todos los identificadores de SMB en este archivo.
Parameters:
null
, se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudFileClient).
Returns:
Throws:
create
public void create()
Crea el directorio.
Throws:
create
public void create(FileRequestOptions options, OperationContext opContext)
Crea el directorio con las opciones y el contexto de operación especificados.
Parameters:
null
, se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudFileClient).
Throws:
createIfNotExists
public boolean createIfNotExists()
Crea el directorio si no existe.
Returns:
Es true
si el directorio no existía todavía y se creó. En caso contrario, es false
.
Throws:
createIfNotExists
public boolean createIfNotExists(FileRequestOptions options, OperationContext opContext)
Crea el directorio si no existe, con las opciones de solicitud y el contexto de operación especificados.
Parameters:
null
, se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado (CloudFileClient).
Returns:
Es true
si el directorio no existía todavía y se creó. En caso contrario, es false
.
Throws:
delete
public void delete()
Elimina el directorio.
Throws:
delete
public void delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Elimina el directorio mediante las opciones de solicitud y el contexto de operación especificados.
Parameters:
null
, se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudFileClient).
Throws:
deleteIfExists
public boolean deleteIfExists()
Elimina el directorio si existe.
Returns:
Es true
si el directorio no existía todavía y se creó. En caso contrario, es false
.
Throws:
deleteIfExists
public boolean deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Elimina el directorio si existe mediante las opciones de solicitud y el contexto de operación especificados.
Parameters:
null
, se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudFileClient).
Returns:
true
si el directorio existía y se eliminó; de lo contrario, false
.
Throws:
downloadAttributes
public void downloadAttributes()
Descarga las propiedades del directorio.
Throws:
downloadAttributes
public void downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Descarga las propiedades del directorio mediante las opciones de solicitud y el contexto de operación especificados.
Parameters:
null
, se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudFileClient).
Throws:
exists
public boolean exists()
Devuelve un valor que indica si el directorio existe.
Returns:
true
es si el directorio existe; de lo contrario false
, es .
Throws:
exists
public boolean exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Devuelve un valor que indica si el directorio existe, utilizando las opciones de solicitud y el contexto de operación especificados.
Parameters:
null
, se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudFileClient).
Returns:
true
es si el directorio existe; de lo contrario false
, es .
Throws:
getDirectoryReference
public CloudFileDirectory getDirectoryReference(final String itemName)
Devuelve una referencia a un CloudFileDirectory objeto que representa un directorio de este directorio.
Parameters:
String
representa el nombre del directorio.
Returns:
Throws:
getFileReference
public CloudFile getFileReference(final String fileName)
Devuelve una referencia a un CloudFile objeto que representa un archivo en este directorio.
Parameters:
String
representa el nombre del archivo.
Returns:
Throws:
getMetadata
public HashMap
Devuelve los metadatos del directorio. Este valor se inicializa con los metadatos del directorio mediante una llamada a downloadAttributes()y se establece en el directorio con una llamada a uploadMetadata().
Returns:
java.util.HashMap
que representa los metadatos del directorio.getName
public String getName()
Devuelve el nombre de este directorio.
Returns:
String
representa el nombre del directorio.getParent
public CloudFileDirectory getParent()
Devuelve el CloudFileDirectory directorio primario asociado a este directorio.
Overrides:
CloudFileDirectory.getParent()Returns:
Throws:
getProperties
public FileDirectoryProperties getProperties()
Devuelve el FileDirectoryProperties objeto que contiene las propiedades del sistema del directorio.
Returns:
getServiceClient
public CloudFileClient getServiceClient()
Devuelve el cliente del servicio de archivos asociado a este directorio.
Returns:
getShare
public CloudFileShare getShare()
Devuelve el recurso compartido de este directorio.
Overrides:
CloudFileDirectory.getShare()Returns:
Throws:
getStorageUri
public final StorageUri getStorageUri()
Devuelve la lista de URI para todas las ubicaciones.
Overrides:
CloudFileDirectory.getStorageUri()Returns:
getUri
public URI getUri()
Devuelve el URI de este directorio.
Overrides:
CloudFileDirectory.getUri()Returns:
java.net.URI
que representa el URI de este directorio.listFilesAndDirectories
public Iterable
Devuelve una colección enumerable de elementos de archivo y directorio para el directorio.
Returns:
listFilesAndDirectories
public Iterable
Devuelve una colección enumerable de elementos de archivo y directorio para el directorio.
Parameters:
null
, se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudFileClient).
Returns:
listFilesAndDirectories
public Iterable
Devuelve una colección enumerable de elementos de archivo y directorio para el directorio.
Parameters:
null
, se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudFileClient).
Returns:
listFilesAndDirectoriesSegmented
public ResultSegment
Devuelve un segmento de resultado de una colección enumerable de archivos y directorios para este cliente de servicio de archivos.
Returns:
Throws:
listFilesAndDirectoriesSegmented
public ResultSegment
Devuelve un segmento de resultado de una colección enumerable de archivos y directorios para este directorio, utilizando las opciones de detalles de la lista especificadas, las opciones de solicitud y el contexto de la operación.
Parameters:
null
o superior a 5000, el servidor devolverá hasta 5000 elementos. Debe ser 1 como mínimo.
null
, se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudFileClient).
Returns:
Throws:
listFilesAndDirectoriesSegmented
public ResultSegment
Devuelve un segmento de resultado de una colección enumerable de archivos y directorios para este directorio, utilizando las opciones de detalles de la lista especificadas, las opciones de solicitud y el contexto de la operación.
Parameters:
null
o superior a 5000, el servidor devolverá hasta 5000 elementos. Debe ser 1 como mínimo.
null
, se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudFileClient).
Returns:
Throws:
listHandles
public Iterable
Obtiene los identificadores SMB abiertos en este archivo.
Returns:
Uniterable
</code> of the handles that will lazily request new segments. </p>
listHandles
public Iterable listHandles(boolean recursive, FileRequestOptions options, OperationContext opContext)
Obtiene los identificadores SMB abiertos en este archivo.
Parameters:
recursive
- Especifica si la operación debe aplicarse al directorio especificado en el URI, sus archivos, sus subdirectorios y sus archivos.
options
- Objeto FileRequestOptions que especifica las opciones adicionales de la solicitud. Al especificar null
, se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudFileClient).
opContext
- Objeto OperationContext que representa el contexto de la operación actual. Este objeto se utiliza para hacer un seguimiento de las solicitudes al servicio de almacenamiento y para proporcionar información adicional en tiempo de ejecución sobre la operación.
Returns:
Uniterable
</code> of the handles that will lazily request new segments. </p>
listHandlesSegmented
public ResultSegment listHandlesSegmented()
Obtiene los identificadores SMB abiertos en este archivo.
Returns:
Objeto ResultSegment<T> que contiene un segmento de la colección enumerable de ListFileItem objetos que representan los archivos y directorios.
Throws:
StorageException
listHandlesSegmented
public ResultSegment listHandlesSegmented(final Integer maxResults, final boolean recursive, final ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)
Obtiene los identificadores SMB abiertos en este archivo.
Parameters:
maxResults
- Número máximo de resultados que se van a recuperar. Si null
o superior a 5000, el servidor devolverá hasta 5000 elementos. Debe ser 1 como mínimo.
recursive
- Especifica si la operación debe aplicarse al directorio especificado en el URI, sus archivos, sus subdirectorios y sus archivos.
continuationToken
- Objeto ResultContinuation que representa un token de continuación devuelto por una operación de lista anterior.
options
- Objeto FileRequestOptions que especifica las opciones adicionales de la solicitud. Al especificar null
, se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudFileClient).
opContext
- Objeto OperationContext que representa el contexto de la operación actual. Este objeto se utiliza para hacer un seguimiento de las solicitudes al servicio de almacenamiento y para proporcionar información adicional en tiempo de ejecución sobre la operación.
Returns:
Objeto ResultSegment<T> que contiene un segmento de la colección enumerable de ListFileItem objetos que representan los archivos y directorios.
Throws:
StorageException
setFilePermission
public void setFilePermission(String filePermission)
Establece el permiso de archivo del directorio
Parameters:
filePermission
- que String
representa el permiso de archivo del directorio.
setMetadata
public void setMetadata(HashMap metadata)
Establece la colección de metadatos de pares nombre-valor que se van a establecer en el directorio con una uploadMetadata() llamada. Esta colección sobrescribirá los metadatos de directorio existentes. Si se establece en una colección vacía, los metadatos del directorio se borrarán en una uploadMetadata() llamada.
Parameters:
metadata
- Objeto java.util.HashMap
que representa los metadatos que se asignan al directorio.
setProperties
protected final void setProperties(final FileDirectoryProperties properties)
Establece las propiedades del directorio.
Parameters:
properties
- Objeto FileDirectoryProperties que representa las propiedades que se asignan al directorio.
setShare
protected final void setShare(final CloudFileShare share)
Establece el recurso compartido para el directorio.
Parameters:
share
- Objeto CloudFileShare que representa el recurso compartido que se asigna al directorio.
setStorageUri
protected void setStorageUri(final StorageUri storageUri)
Establece la lista de URI para todas las ubicaciones.
Parameters:
storageUri
- que StorageUri representa la lista de URI para todas las ubicaciones.
uploadMetadata
public void uploadMetadata()
Carga los metadatos del directorio.
Throws:
StorageException
- Si se produjo un error en el servicio de almacenamiento.
URISyntaxException
uploadMetadata
public void uploadMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Carga los metadatos del directorio mediante las opciones de solicitud y el contexto de operación especificados.
Parameters:
accessCondition
- Objeto AccessCondition que representa las condiciones de acceso del directorio.
options
- Objeto FileRequestOptions que especifica las opciones adicionales de la solicitud. Al especificar null
, se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudFileClient).
opContext
- Objeto OperationContext que representa el contexto para la operación actual. Este objeto se utiliza para hacer un seguimiento de las solicitudes al servicio de almacenamiento y para proporcionar información adicional en tiempo de ejecución sobre la operación.
Throws:
StorageException
- Si se produjo un error en el servicio de almacenamiento.
URISyntaxException
uploadProperties
public final void uploadProperties()
Carga las propiedades del directorio en el servicio de almacenamiento.
Use downloadAttributes() para recuperar los valores más recientes de las propiedades y metadatos del directorio del servicio de almacenamiento de Microsoft Azure.
Throws:
StorageException
- Si se produjo un error en el servicio de almacenamiento.
URISyntaxException
uploadProperties
public final void uploadProperties(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Carga las propiedades del directorio mediante la condición de acceso, las opciones de solicitud y el contexto de la operación.
Use downloadAttributes() para recuperar los valores más recientes de las propiedades y metadatos del directorio del servicio de almacenamiento de Microsoft Azure.
Parameters:
accessCondition
- Objeto AccessCondition que representa las condiciones de acceso del directorio.
options
- Objeto FileRequestOptions que especifica las opciones adicionales de la solicitud. Al especificar null
, se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudFileClient).
opContext
- Objeto OperationContext que representa el contexto para la operación actual. Este objeto se utiliza para hacer un seguimiento de las solicitudes al servicio de almacenamiento y para proporcionar información adicional en tiempo de ejecución sobre la operación.
Throws:
StorageException
- Si se produjo un error en el servicio de almacenamiento.
URISyntaxException
Se aplica a
Azure SDK for Java