CloudFileClient Clase

Paquete:

com.microsoft.azure.storage.file

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

public class CloudFileClient extends ServiceClient

Proporciona un cliente para acceder al servicio Microsoft Azure File.

Esta clase proporciona un punto de acceso al servicio File. El cliente del servicio encapsula el URI base para el servicio Archivo. También encapsula las credenciales para acceder a la cuenta de almacenamiento.

Resumen del constructor

Constructor	Description
CloudFileClient(final URI baseUri, StorageCredentials credentials)	Crea una instancia de la clase mediante el punto de conexión de servicio de archivos y las credenciales de cuenta especificados.
CloudFileClient(StorageUri storageUri, StorageCredentials credentials)	Crea una instancia de la clase mediante el punto de conexión de servicio de archivos y las credenciales de cuenta especificados.

Resumen del método

Modificador y tipo	Método y descripción
final FileServiceProperties	downloadServiceProperties() Recupera el actual FileServiceProperties para el servicio de almacenamiento determinado. Esto encapsula las configuraciones de CORS.
final FileServiceProperties	downloadServiceProperties(FileRequestOptions options, OperationContext opContext) Recupera el actual FileServiceProperties para el servicio de almacenamiento determinado. Esto encapsula las configuraciones de CORS.
FileRequestOptions	getDefaultRequestOptions() Obtiene el FileRequestOptions objeto que se usa para las solicitudes asociadas a este objeto.
CloudFileShare	getShareReference(final String shareName) Obtiene un CloudFileShare objeto con el nombre especificado.
CloudFileShare	getShareReference(final String shareName, String snapshotID) Obtiene un CloudFileShare objeto con el nombre especificado.
boolean	isUsePathStyleUris() Indica si se usan URI de estilo de ruta de acceso.
Iterable<CloudFileShare>	listShares() Devuelve una colección enumerable de recursos compartidos para este cliente de servicio de archivos.
Iterable<CloudFileShare>	listShares(final String prefix) Devuelve una colección enumerable de recursos compartidos cuyos nombres comienzan con el prefijo especificado para este cliente de servicio de archivos.
Iterable<CloudFileShare>	listShares(final String prefix, final EnumSet<ShareListingDetails> detailsIncluded, final FileRequestOptions options, final OperationContext opContext) Devuelve una colección enumerable de recursos compartidos cuyos nombres comienzan con el prefijo especificado para este cliente de servicio de archivos, utilizando la configuración de detalles, las opciones de solicitud y el contexto de operación especificados.
ResultSegment<CloudFileShare>	listSharesSegmented() Devuelve un segmento de resultado de una colección enumerable de recursos compartidos para este cliente de servicio de archivos.
ResultSegment<CloudFileShare>	listSharesSegmented(final String prefix) Devuelve un segmento de resultado de una colección enumerable de recursos compartidos cuyos nombres comienzan por el prefijo especificado para este cliente de servicio de archivos.
ResultSegment<CloudFileShare>	listSharesSegmented(final String prefix, final EnumSet<ShareListingDetails> detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final FileRequestOptions options, final OperationContext opContext) Devuelve un segmento de resultado de una colección enumerable de recursos compartidos cuyos nombres comienzan con el prefijo especificado, utilizando las opciones de detalles de la lista, las opciones de solicitud y el contexto de operación especificados.
void	setDefaultRequestOptions(FileRequestOptions defaultRequestOptions) Establece el FileRequestOptions objeto que se usa para las solicitudes asociadas a este objeto.
void	uploadServiceProperties(final FileServiceProperties properties) Carga una nueva FileServiceProperties configuración en el servicio de almacenamiento especificado. Esto encapsula las configuraciones de CORS.
void	uploadServiceProperties(final FileServiceProperties properties, FileRequestOptions options, OperationContext opContext) Carga una nueva FileServiceProperties configuración en el servicio de almacenamiento especificado. Esto encapsula las configuraciones de CORS.

Miembros heredados

ServiceClient.credentials ServiceClient.downloadServicePropertiesImpl(final RequestOptions options, final boolean signAsTable) ServiceClient.getCredentials() ServiceClient.getEndpoint() ServiceClient.getServiceStatsImpl(final RequestOptions options, final boolean signAsTable) ServiceClient.getStorageUri() ServiceClient.ServiceClient(final StorageUri storageUri, final StorageCredentials credentials) ServiceClient.setCredentials(final StorageCredentials credentials) ServiceClient.setStorageUri(final StorageUri storageUri) ServiceClient.uploadServicePropertiesImpl(final ServiceProperties properties, final RequestOptions options, final OperationContext opContext, final boolean signAsTable)

Detalles del constructor

CloudFileClient

public CloudFileClient(final URI baseUri, StorageCredentials credentials)

Crea una instancia de la clase mediante el punto de conexión de servicio de archivos y las credenciales de cuenta especificados.

Parameters:

baseUri - Objeto java.net.URI que representa el punto de conexión del servicio file usado para crear el cliente.

credentials - Objeto StorageCredentials que representa las credenciales de la cuenta.

CloudFileClient

public CloudFileClient(StorageUri storageUri, StorageCredentials credentials)

Crea una instancia de la clase mediante el punto de conexión de servicio de archivos y las credenciales de cuenta especificados.

Parameters:

storageUri - Objeto StorageUri que representa el punto de conexión del servicio file usado para crear el cliente.

credentials - Objeto StorageCredentials que representa las credenciales de la cuenta.

Detalles del método

downloadServiceProperties

public final FileServiceProperties downloadServiceProperties()

Recupera el actual FileServiceProperties para el servicio de almacenamiento determinado. Esto encapsula las configuraciones de CORS.

Returns:

Objeto FileServiceProperties que representa la configuración actual del servicio.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.

downloadServiceProperties

public final FileServiceProperties downloadServiceProperties(FileRequestOptions options, OperationContext opContext)

Recupera el actual FileServiceProperties para el servicio de almacenamiento determinado. Esto encapsula las configuraciones de CORS.

Parameters:

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.

Returns:

Objeto FileServiceProperties que representa la configuración actual del servicio.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.

getDefaultRequestOptions

public FileRequestOptions getDefaultRequestOptions()

Obtiene el FileRequestOptions objeto que se usa para las solicitudes asociadas a este objeto.

Returns:

Objeto FileRequestOptions que contiene los valores usados por este objeto. CloudFileClient

getShareReference

public CloudFileShare getShareReference(final String shareName)

Obtiene un CloudFileShare objeto con el nombre especificado.

Parameters:

shareName - 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 (-).

Returns:

Referencia a un objeto CloudFileShare.

Throws:

StorageException

URISyntaxException

getShareReference

public CloudFileShare getShareReference(final String shareName, String snapshotID)

Obtiene un CloudFileShare objeto con el nombre especificado.

Parameters:

shareName - 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 (-).

snapshotID - que String representa el identificador de instantánea del recurso compartido.

Returns:

Referencia a un objeto CloudFileShare.

Throws:

StorageException

URISyntaxException

isUsePathStyleUris

protected boolean isUsePathStyleUris()

Indica si se usan URI de estilo de ruta de acceso.

Returns:

true si usa URI de estilo de ruta de acceso; de lo contrario, false.

listShares

public Iterable listShares()

Devuelve una colección enumerable de recursos compartidos para este cliente de servicio de archivos.

Returns:

Colección enumerable de CloudFileShare objetos recuperados de forma diferida que representan los recursos compartidos de este cliente.

listShares

public Iterable listShares(final String prefix)

Devuelve una colección enumerable de recursos compartidos cuyos nombres comienzan con el prefijo especificado para este cliente de servicio de archivos.

Parameters:

prefix - que String representa el prefijo del nombre del recurso compartido.

Returns:

Colección enumerable de CloudFileShare objetos recuperados de forma diferida que representan los recursos compartidos de este cliente cuyos nombres comienzan con el prefijo especificado.

listShares

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

Devuelve una colección enumerable de recursos compartidos cuyos nombres comienzan con el prefijo especificado para este cliente de servicio de archivos, utilizando la configuración de detalles, las opciones de solicitud y el contexto de operación especificados.

Parameters:

prefix - que String representa el prefijo del nombre del recurso compartido.

detailsIncluded - Objeto java.util.EnumSet que contiene ShareListingDetails valores que indican si se devolverán instantáneas de recurso compartido o metadatos.

options - Objeto FileRequestOptions que especifica las opciones adicionales para 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.

Returns:

Colección enumerable de CloudFileShare objetos recuperados de forma diferida que representa los recursos compartidos de este cliente.

listSharesSegmented

public ResultSegment listSharesSegmented()

Devuelve un segmento de resultado de una colección enumerable de recursos compartidos para este cliente de servicio de archivos.

Returns:

Objeto ResultSegment<T> que contiene un segmento de la colección enumerable de CloudFileShare objetos que representan los recursos compartidos de este cliente.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.

listSharesSegmented

public ResultSegment listSharesSegmented(final String prefix)

Devuelve un segmento de resultado de una colección enumerable de recursos compartidos cuyos nombres comienzan por el prefijo especificado para este cliente de servicio de archivos.

Parameters:

prefix - que String representa el prefijo del nombre del recurso compartido.

Returns:

Objeto ResultSegment<T> que contiene un segmento de la colección enumerable de CloudFileShare objetos que representan los recursos compartidos cuyos nombres comienzan por el prefijo especificado.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.

listSharesSegmented

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

Devuelve un segmento de resultado de una colección enumerable de recursos compartidos cuyos nombres comienzan con el prefijo especificado, utilizando las opciones de detalles de la lista, las opciones de solicitud y el contexto de operación especificados.

Parameters:

prefix - que String representa el prefijo del nombre del recurso compartido.

detailsIncluded - Objeto java.util.EnumSet que contiene ShareListingDetails valores que indican si se devolverán instantáneas de recurso compartido o metadatos.

maxResults - Número máximo de resultados que se van a recuperar. Si null o mayor que 5000, el servidor devolverá hasta 5000 elementos. Debe ser 1 como mínimo.

continuationToken - Objeto ResultContinuation que representa un token de continuación devuelto por una operación de enumeración anterior.

options - Objeto FileRequestOptions que especifica las opciones adicionales para 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.

Returns:

Objeto ResultSegment<T> que contiene un segmento de la colección enumerable de CloudFileShare objetos que representan los recursos compartidos de este cliente.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.

setDefaultRequestOptions

public void setDefaultRequestOptions(FileRequestOptions defaultRequestOptions)

Establece el FileRequestOptions objeto que se usa para las solicitudes asociadas a este objeto.

Parameters:

defaultRequestOptions - Objeto FileRequestOptions que especifica las opciones que se van a usar.

uploadServiceProperties

public void uploadServiceProperties(final FileServiceProperties properties)

Carga una nueva FileServiceProperties configuración en el servicio de almacenamiento especificado. Esto encapsula las configuraciones de CORS.

Parameters:

properties - Objeto FileServiceProperties que especifica las propiedades del servicio que se van a cargar.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.

uploadServiceProperties

public void uploadServiceProperties(final FileServiceProperties properties, FileRequestOptions options, OperationContext opContext)

Carga una nueva FileServiceProperties configuración en el servicio de almacenamiento especificado. Esto encapsula las configuraciones de CORS.

Parameters:

properties - Objeto FileServiceProperties que especifica las propiedades del servicio que se van a cargar.

options - Objeto FileRequestOptions que especifica las opciones adicionales para 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.