CloudFileShare Clase
- java.
lang. Object - com.
microsoft. azure. storage. file. CloudFileShare
- com.
public class CloudFileShare
Representa un recurso compartido en el servicio Microsoft Azure File.
Los recursos compartidos contienen directorios, que se encapsulan como CloudFileDirectory objetos y directorios contienen archivos. Los directorios también pueden contener subdirectorios.
Resumen del constructor
Constructor | Description |
---|---|
CloudFileShare(final StorageUri storageUri) |
Crea una instancia de la clase mediante el URI especificado. |
CloudFileShare(final StorageUri storageUri, final StorageCredentials credentials) |
Crea una instancia de la clase mediante el storageUri y las credenciales especificados. |
CloudFileShare(final String shareName, String snapshotID, final CloudFileClient client) |
Crea una instancia de la clase utilizando el nombre y el cliente especificados. |
CloudFileShare(final URI uri) |
Crea una instancia de la clase mediante el URI especificado. |
CloudFileShare(final URI uri, final StorageCredentials credentials) |
Crea una instancia de la clase mediante el URI y las credenciales especificados. |
Resumen del método
Modificador y tipo | Método y descripción |
---|---|
void |
assertNoSnapshot()
Afirma que el recurso compartido no es una instantánea. |
void |
create()
Crea el recurso compartido. |
void |
create(FileRequestOptions options, OperationContext opContext)
Crea el recurso compartido mediante las opciones y el contexto de operación especificados. |
String |
createFilePermission(String permission)
Crea un permiso de archivo. |
String |
createFilePermission(String permission, FileRequestOptions options, OperationContext opContext)
Crea un permiso de archivo. |
boolean |
createIfNotExists()
Crea el recurso compartido si no existe. |
boolean |
createIfNotExists(FileRequestOptions options, OperationContext opContext)
Crea el recurso compartido si no existe, con las opciones de solicitud y el contexto de operación especificados. |
final Cloud |
createSnapshot()
Crea una instantánea del recurso compartido. |
final Cloud |
createSnapshot(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Crea una instantánea del recurso compartido de archivos mediante las opciones de solicitud y el contexto de operación especificados. |
final Cloud |
createSnapshot(final HashMap<String, String> metadata, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Crea una instantánea del recurso compartido de archivos mediante las opciones de solicitud y el contexto de operación especificados. |
void |
delete()
Elimina el recurso compartido. |
void |
delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Elimina el recurso compartido mediante las opciones de solicitud y el contexto de operación especificados. |
void |
delete(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Elimina el recurso compartido con las opciones de instantánea y solicitud especificadas y el contexto de operación. Un recurso compartido que tiene instantáneas no se puede eliminar a menos que también se eliminen las instantáneas. Si un recurso compartido tiene instantáneas, use el INCLUDE_SNAPSHOTS valor del parámetro para incluir las instantáneas al eliminar el recurso compartido base. |
boolean |
deleteIfExists()
Elimina el recurso compartido si existe. |
boolean |
deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Elimina el recurso compartido si existe mediante las opciones de solicitud y el contexto de operación especificados. |
boolean |
deleteIfExists(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Elimina el recurso compartido si existe, utilizando las opciones de instantánea y solicitud especificadas y el contexto de operación. Un recurso compartido que tiene instantáneas no se puede eliminar a menos que también se eliminen las instantáneas. Si un recurso compartido tiene instantáneas, use el INCLUDE_SNAPSHOTS valor del parámetro para incluir las instantáneas al eliminar el recurso compartido base. |
void |
downloadAttributes()
Descarga los atributos del recurso compartido, que constan de metadatos y propiedades. |
void |
downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Descarga los atributos del recurso compartido, que constan de metadatos y propiedades, mediante las opciones de solicitud y el contexto de operación especificados. |
File |
downloadPermissions()
Descarga la configuración de permisos para el recurso compartido. |
File |
downloadPermissions(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Descarga la configuración de permisos para el recurso compartido mediante las opciones de solicitud y el contexto de operación especificados. |
boolean |
exists()
Devuelve un valor que indica si el recurso compartido existe. |
boolean |
exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Devuelve un valor que indica si el recurso compartido existe, utilizando las opciones de solicitud y el contexto de operación especificados. |
String |
generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier)
Devuelve una firma de acceso compartido para el recurso compartido. Tenga en cuenta que esto no contiene el "?". |
String |
generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)
Devuelve una firma de acceso compartido para el recurso compartido. Tenga en cuenta que esto no contiene el "?". |
String |
getFilePermission(String filePermissionKey)
Obtiene el permiso de archivo asociado a una clave de permiso de archivo. |
String |
getFilePermission(String filePermissionKey, FileRequestOptions options, OperationContext opContext)
Obtiene el permiso de archivo asociado a una clave de permiso de archivo. |
HashMap<String, String> |
getMetadata()
Devuelve los metadatos del recurso compartido. Este valor se inicializa con los metadatos del recurso compartido mediante una llamada a downloadAttributes()y se establece en el recurso compartido con una llamada a uploadMetadata(). |
String |
getName()
Devuelve el nombre del recurso compartido. |
File |
getProperties()
Devuelve las propiedades del recurso compartido. |
final URI |
getQualifiedUri()
Devuelve el URI completo de la firma de acceso compartido o instantánea para este recurso compartido. |
Cloud |
getRootDirectoryReference()
Devuelve una referencia a un CloudFileDirectory objeto que representa el directorio de archivos raíz dentro de este recurso compartido. |
Cloud |
getServiceClient()
Devuelve el cliente del servicio de archivos asociado a este recurso compartido. |
final String |
getSnapshot()
Devuelve el snapshotID de este recurso compartido. |
Share |
getStats()
Consulta el servicio de este recurso compartido ShareStats. |
Share |
getStats(FileRequestOptions options, OperationContext opContext)
Consulta el servicio de este recurso compartido ShareStats. |
Storage |
getStorageUri()
Devuelve la lista de URI para todas las ubicaciones. |
URI |
getUri()
Devuelve el URI de este recurso compartido. |
final boolean |
isSnapshot()
Indica si este recurso compartido es una instantánea. |
void |
setMetadata(final HashMap<String, String> metadata)
Establece la colección de metadatos de pares nombre-valor que se van a establecer en el recurso compartido con una uploadMetadata() llamada. Esta colección sobrescribirá los metadatos de recurso compartido existentes. Si se establece en una colección vacía, los metadatos del recurso compartido se borrarán en una uploadMetadata() llamada. |
void |
setProperties(final FileShareProperties properties)
Establece las propiedades del recurso compartido. |
void |
uploadMetadata()
Carga los metadatos del recurso compartido. |
void |
uploadMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Carga los metadatos del recurso compartido mediante las opciones de solicitud y el contexto de operación especificados. |
void |
uploadPermissions(final FileSharePermissions permissions)
Carga los permisos del recurso compartido. |
void |
uploadPermissions(final FileSharePermissions permissions, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Carga los permisos del recurso compartido mediante las opciones de solicitud y el contexto de operación especificados. |
final void |
uploadProperties()
Novedades las propiedades del recurso compartido en el servicio de almacenamiento. Use downloadAttributes() para recuperar los valores más recientes de las propiedades y metadatos del recurso compartido del servicio de almacenamiento de Microsoft Azure. |
final void |
uploadProperties(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Novedades las propiedades del recurso compartido mediante 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 recurso compartido del servicio de almacenamiento de Microsoft Azure. |
Detalles del constructor
CloudFileShare
public CloudFileShare(final StorageUri storageUri)
Crea una instancia de la clase mediante el URI especificado.
Parameters:
Throws:
CloudFileShare
public CloudFileShare(final StorageUri storageUri, final StorageCredentials credentials)
Crea una instancia de la clase mediante el storageUri y las credenciales especificados.
Parameters:
Throws:
CloudFileShare
public CloudFileShare(final String shareName, String snapshotID, final CloudFileClient client)
Crea una instancia de la clase utilizando el nombre y el cliente especificados.
Parameters:
String
representa el nombre del recurso compartido, que debe cumplir las reglas de nomenclatura de recursos compartidos. El nombre del recurso compartido no debe incluir ningún carácter separador de ruta de acceso (/). Los nombres de recurso compartido deben estar en minúsculas, entre 3 y 63 caracteres y deben comenzar con una letra o un número. Los nombres compartidos solo pueden contener letras, números y el carácter de guión (-).
String
representa la versión de instantánea, si procede.
Throws:
CloudFileShare
public CloudFileShare(final URI uri)
Crea una instancia de la clase mediante el URI especificado.
Parameters:
java.net.URI
que representa el URI absoluto del recurso compartido.
Throws:
CloudFileShare
public CloudFileShare(final URI uri, final StorageCredentials credentials)
Crea una instancia de la clase mediante el URI y las credenciales especificados.
Parameters:
java.net.URI
que representa el URI absoluto del recurso compartido.
Throws:
Detalles del método
assertNoSnapshot
protected void assertNoSnapshot()
Afirma que el recurso compartido no es una instantánea.
create
public void create()
Crea el recurso compartido.
Throws:
create
public void create(FileRequestOptions options, OperationContext opContext)
Crea el recurso compartido mediante 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:
createFilePermission
public String createFilePermission(String permission)
Crea un permiso de archivo.
Parameters:
String
que representa el permiso de archivo que se va a crear.
Returns:
String
que representa la clave de permiso de archivo asociada al permiso de archivo creado.Throws:
createFilePermission
public String createFilePermission(String permission, FileRequestOptions options, OperationContext opContext)
Crea un permiso de archivo.
Parameters:
String
que representa el permiso de archivo que se va a crear.
null
, se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudFileClient).
Returns:
String
que representa la clave de permiso de archivo asociada al permiso de archivo creado.Throws:
createIfNotExists
public boolean createIfNotExists()
Crea el recurso compartido si no existe.
Returns:
Es true
si el recurso compartido no existía todavía y se creó; en caso contrario, es false
.
Throws:
createIfNotExists
public boolean createIfNotExists(FileRequestOptions options, OperationContext opContext)
Crea el recurso compartido 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 recurso compartido no existía todavía y se creó; en caso contrario, es false
.
Throws:
createSnapshot
public final CloudFileShare createSnapshot()
Crea una instantánea del recurso compartido.
Returns:
CloudFileShare
que representa la instantánea del recurso compartido.Throws:
createSnapshot
public final CloudFileShare createSnapshot(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Crea una instantánea del recurso compartido de archivos 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:
CloudFileShare
que representa la instantánea del recurso compartido de archivos.Throws:
createSnapshot
public final CloudFileShare createSnapshot(final HashMap
Crea una instantánea del recurso compartido de archivos 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:
CloudFileShare
que representa la instantánea del recurso compartido de archivos.Throws:
delete
public void delete()
Elimina el recurso compartido.
Throws:
delete
public void delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Elimina el recurso compartido 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:
delete
public void delete(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Elimina el recurso compartido con las opciones de instantánea y solicitud especificadas y el contexto de operación.
Un recurso compartido que tiene instantáneas no se puede eliminar a menos que también se eliminen las instantáneas. Si un recurso compartido tiene instantáneas, use el INCLUDE_SNAPSHOTS valor del parámetro para incluir las instantáneas al eliminar el recurso compartido base.
Parameters:
null
se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudFileClient).
Throws:
deleteIfExists
public boolean deleteIfExists()
Elimina el recurso compartido si existe.
Returns:
true
si el recurso compartido existía y se eliminó; de lo contrario, false
.
Throws:
deleteIfExists
public boolean deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Elimina el recurso compartido 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 recurso compartido existía y se eliminó; de lo contrario, false
.
Throws:
deleteIfExists
public boolean deleteIfExists(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Elimina el recurso compartido si existe, utilizando las opciones de instantánea y solicitud especificadas y el contexto de operación.
Un recurso compartido que tiene instantáneas no se puede eliminar a menos que también se eliminen las instantáneas. Si un recurso compartido tiene instantáneas, use el INCLUDE_SNAPSHOTS valor del parámetro para incluir las instantáneas al eliminar el recurso compartido base.
Parameters:
null
se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudFileClient).
Returns:
true
si el recurso compartido existía y se eliminó; de lo contrario, false
.
Throws:
downloadAttributes
public void downloadAttributes()
Descarga los atributos del recurso compartido, que constan de metadatos y propiedades.
Throws:
downloadAttributes
public void downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Descarga los atributos del recurso compartido, que constan de metadatos y propiedades, 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:
downloadPermissions
public FileSharePermissions downloadPermissions()
Descarga la configuración de permisos para el recurso compartido.
Returns:
Throws:
downloadPermissions
public FileSharePermissions downloadPermissions(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Descarga la configuración de permisos para el recurso compartido 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:
Throws:
exists
public boolean exists()
Devuelve un valor que indica si el recurso compartido existe.
Returns:
true
es si el recurso compartido 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 recurso compartido 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 recurso compartido existe; de lo contrario false
, es .
Throws:
generateSharedAccessSignature
public String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier)
Devuelve una firma de acceso compartido para el recurso compartido. Tenga en cuenta que esto no contiene el "?".
Parameters:
String
representa la directiva de acceso de nivel de recurso compartido.
Returns:
String
representa una firma de acceso compartido para el recurso compartido.Throws:
generateSharedAccessSignature
public String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)
Devuelve una firma de acceso compartido para el recurso compartido. Tenga en cuenta que esto no contiene el "?".
Parameters:
String
representa la directiva de acceso de nivel de recurso compartido.
Returns:
String
representa una firma de acceso compartido para el recurso compartido.Throws:
getFilePermission
public String getFilePermission(String filePermissionKey)
Obtiene el permiso de archivo asociado a una clave de permiso de archivo.
Parameters:
String
que representa la clave de permiso de archivo.
Returns:
String
representa el permiso de archivo asociado a la clave de permiso de archivo.Throws:
getFilePermission
public String getFilePermission(String filePermissionKey, FileRequestOptions options, OperationContext opContext)
Obtiene el permiso de archivo asociado a una clave de permiso de archivo.
Parameters:
String
que representa la clave de permiso de archivo.
null
se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudFileClient).
Returns:
String
representa el permiso de archivo asociado a la clave de permiso de archivo.Throws:
getMetadata
public HashMap
Devuelve los metadatos del recurso compartido. Este valor se inicializa con los metadatos del recurso compartido mediante una llamada a downloadAttributes()y se establece en el recurso compartido con una llamada a uploadMetadata().
Returns:
java.util.HashMap
que representa los metadatos del recurso compartido.getName
public String getName()
Devuelve el nombre del recurso compartido.
Returns:
String
representa el nombre del recurso compartido.getProperties
public FileShareProperties getProperties()
Devuelve las propiedades del recurso compartido.
Returns:
getQualifiedUri
public final URI getQualifiedUri()
Devuelve el URI completo de la firma de acceso compartido o instantánea para este recurso compartido.
Returns:
java.net.URI
que representa la instantánea o la firma de acceso compartido.Throws:
getRootDirectoryReference
public CloudFileDirectory getRootDirectoryReference()
Devuelve una referencia a un CloudFileDirectory objeto que representa el directorio de archivos raíz dentro de este recurso compartido.
Returns:
Throws:
getServiceClient
public CloudFileClient getServiceClient()
Devuelve el cliente del servicio de archivos asociado a este recurso compartido.
Returns:
getSnapshot
public final String getSnapshot()
Devuelve el snapshotID de este recurso compartido.
Returns:
getStats
public ShareStats getStats()
Consulta el servicio de este recurso compartido ShareStats.
Returns:
Throws:
getStats
public ShareStats getStats(FileRequestOptions options, OperationContext opContext)
Consulta el servicio de este recurso compartido ShareStats.
Parameters:
null
, se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado (CloudFileClient).
Returns:
Throws:
getStorageUri
public StorageUri getStorageUri()
Devuelve la lista de URI para todas las ubicaciones.
Returns:
getUri
public URI getUri()
Devuelve el URI de este recurso compartido.
Returns:
isSnapshot
public final boolean isSnapshot()
Indica si este recurso compartido es una instantánea.
Returns:
true
si el recurso compartido es una instantánea; de lo contrario false
, .
setMetadata
public void setMetadata(final HashMap
Establece la colección de metadatos de pares nombre-valor que se van a establecer en el recurso compartido con una uploadMetadata() llamada. Esta colección sobrescribirá los metadatos de recurso compartido existentes. Si se establece en una colección vacía, los metadatos del recurso compartido se borrarán en una uploadMetadata() llamada.
Parameters:
java.util.HashMap
que representa los metadatos que se asignan al recurso compartido.
setProperties
public void setProperties(final FileShareProperties properties)
Establece las propiedades del recurso compartido.
Parameters:
uploadMetadata
public void uploadMetadata()
Carga los metadatos del recurso compartido.
Throws:
uploadMetadata
public void uploadMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Carga los metadatos del recurso compartido 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:
uploadPermissions
public void uploadPermissions(final FileSharePermissions permissions)
Carga los permisos del recurso compartido.
Parameters:
Throws:
uploadPermissions
public void uploadPermissions(final FileSharePermissions permissions, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Carga los permisos del recurso compartido 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:
uploadProperties
public final void uploadProperties()
Novedades las propiedades del recurso compartido en el servicio de almacenamiento.
Use downloadAttributes() para recuperar los valores más recientes de las propiedades y metadatos del recurso compartido del servicio de almacenamiento de Microsoft Azure.
Throws:
uploadProperties
public final void uploadProperties(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Novedades las propiedades del recurso compartido mediante 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 recurso compartido del servicio de almacenamiento de Microsoft Azure.
Parameters:
null
, se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudFileClient).
Throws:
Se aplica a
Azure SDK for Java