EncryptedBlobClientBuilder Clase
- java.
lang. Object - com.
azure. storage. blob. specialized. cryptography. EncryptedBlobClientBuilder
- com.
Implementaciones
public final class EncryptedBlobClientBuilder
implements TokenCredentialTrait<EncryptedBlobClientBuilder>, ConnectionStringTrait<EncryptedBlobClientBuilder>, AzureNamedKeyCredentialTrait<EncryptedBlobClientBuilder>, AzureSasCredentialTrait<EncryptedBlobClientBuilder>, HttpTrait<EncryptedBlobClientBuilder>, ConfigurationTrait<EncryptedBlobClientBuilder>, EndpointTrait<EncryptedBlobClientBuilder>
Esta clase proporciona una API fluent builder para ayudar a ayudar a la configuración y creación de instancias de los clientes de Storage Blob.
Se debe proporcionar la siguiente información en este generador:
- Punto de conexión establecido a través endpoint(String endpoint)de , incluido el nombre del contenedor y el nombre del blob, en el formato de
https://{accountName}.blob.core.windows.net/{containerName}/{blobName}
. - Nombre de contenedor y blob si no se especifica en endpoint(String endpoint), se establece en containerName(String containerName) y blobName(String blobName) respectivamente.
- Credenciales establecidas a través credential(StorageSharedKeyCredential credential) de , sasToken(String sasToken)o connectionString(String connectionString) si el contenedor no es accesible públicamente.
- El algoritmo de ajuste de claves y claves (para el cifrado) o la resolución de claves (para el descifrado) deben especificarse a través key(AsyncKeyEncryptionKey key, String keyWrapAlgorithm) de y keyResolver(AsyncKeyEncryptionKeyResolver keyResolver)
Una vez establecidas todas las configuraciones en este generador, use la siguiente asignación para construir el cliente determinado:
Constructor | Description |
---|---|
Encrypted |
Obsoleto Crea una nueva instancia del Generador de cliente |
Encrypted |
Crea una nueva instancia de Encrypted |
Modificador y tipo | Método y descripción |
---|---|
Encrypted |
add Agrega un HttpPipelinePolicy objeto para aplicar en cada solicitud enviada. |
Encrypted |
blob Configura el generador en función del objeto pasado BlobAsyncClient. |
Encrypted |
blob Configura el generador en función del objeto pasado BlobClient. |
Encrypted |
blob Establece el nombre del blob. |
Encrypted |
build Crea un EncryptedBlobAsyncClient objeto basado en las opciones establecidas en el Generador. |
Encrypted |
build Crea un EncryptedBlobClient objeto basado en las opciones establecidas en el Generador. |
Encrypted |
client Permite establecer propiedades comunes, como el identificador de aplicación, los encabezados, la configuración del proxy, etc. |
Encrypted |
configuration(Configuration configuration)
Establece el objeto de configuración utilizado para recuperar los valores de configuración del entorno durante la compilación del cliente. |
Encrypted |
connection Establece el cadena de conexión para conectarse al servicio. |
Encrypted |
container Establece el nombre del contenedor que contiene el blob. |
Encrypted |
credential(Azure Establece el AzureNamedKeyCredential objeto utilizado para autorizar las solicitudes enviadas al servicio. |
Encrypted |
credential(Azure Establece el AzureSasCredential objeto utilizado para autorizar las solicitudes enviadas al servicio. |
Encrypted |
credential(Token Establece el TokenCredential objeto utilizado para autorizar las solicitudes enviadas al servicio. |
Encrypted |
credential(Storage Establece el StorageSharedKeyCredential objeto utilizado para autorizar las solicitudes enviadas al servicio. |
Encrypted |
customer Establece el CustomerProvidedKey objeto que se usa para cifrar el contenido del blob en el servidor. |
Encrypted |
encryption Establece el |
Encrypted |
endpoint(String endpoint)
Establece el punto de conexión de servicio, además lo analiza para obtener información (token de SAS, nombre de contenedor, nombre de blob) |
static
Http |
get Obtiene los encabezados de registro y los parámetros de consulta de la lista de permitidos de almacenamiento predeterminados. |
Encrypted |
http Establece el HttpClient objeto que se va a usar para enviar y recibir solicitudes hacia y desde el servicio. |
Encrypted |
http Establece el HttpLogOptions objeto que se va a usar al enviar y recibir solicitudes hacia y desde el servicio. |
Encrypted |
key(Async Establece los parámetros de clave de cifrado para el cliente. |
Encrypted |
key Establece los parámetros de cifrado para este cliente. |
Encrypted |
pipeline(Http Establece el objeto HttpPipeline que se va a usar para el cliente de servicio. |
Encrypted |
requires Establece la opción de cifrado requiere cifrado. |
Encrypted |
retry Establece para RetryOptions todas las solicitudes realizadas a través del cliente. |
Encrypted |
retry Establece las opciones de reintento de solicitud para todas las solicitudes realizadas a través del cliente. |
Encrypted |
sas Establece el token de SAS usado para autorizar las solicitudes enviadas al servicio. |
Encrypted |
service Establece el BlobServiceVersion objeto que se usa al realizar solicitudes de API. |
Encrypted |
set Borra la credencial usada para autorizar la solicitud. |
Encrypted |
snapshot(String snapshot)
Establece el identificador de instantánea del blob. |
Encrypted |
version Establece el identificador de versión del blob. |
Métodos heredados de java.lang.Object
EncryptedBlobClientBuilder
@Deprecated
public EncryptedBlobClientBuilder()
Obsoleto
Crea una nueva instancia de EncryptedBlobClientBuilder.
EncryptedBlobClientBuilder
public EncryptedBlobClientBuilder(EncryptionVersion version)
Crea una nueva instancia de EncryptedBlobClientbuilder.
Parámetros:
addPolicy
public EncryptedBlobClientBuilder addPolicy(HttpPipelinePolicy pipelinePolicy)
Agrega un HttpPipelinePolicy objeto para aplicar en cada solicitud enviada.
Nota: Es importante comprender el orden de precedencia de las API de HttpTrait. En concreto, si se especifica , HttpPipeline esto tiene prioridad sobre todas las demás API del rasgo y se omitirán. Si no se especifica ningún HttpPipeline , una canalización HTTP se construirá internamente en función de la configuración proporcionada a este rasgo. Además, puede haber otras API en tipos que implementen este rasgo que también se omiten si se especifica un HttpPipeline , por lo que asegúrese de consultar la documentación de tipos que implementan este rasgo para comprender todo el conjunto de implicaciones.
Parámetros:
Devoluciones:
blobAsyncClient
public EncryptedBlobClientBuilder blobAsyncClient(BlobAsyncClient blobAsyncClient)
Configura el generador en función del objeto pasado BlobAsyncClient. Esto establecerá , HttpPipelineURL y BlobServiceVersion que se usan para interactuar con el servicio. Tenga en cuenta que la canalización subyacente aún no debe configurarse para el cifrado o descifrado.
Si pipeline
se establece, se omiten todas las demás configuraciones, aparte de endpoint(String endpoint) y serviceVersion(BlobServiceVersion version).
Tenga en cuenta que, por motivos de seguridad, este método no copia las propiedades del CustomerProvidedKey ámbito de cifrado y del cliente proporcionado. Para establecer CPK, use customerProvidedKey(CustomerProvidedKey customerProvidedKey).
Parámetros:
Devoluciones:
blobClient
public EncryptedBlobClientBuilder blobClient(BlobClient blobClient)
Configura el generador en función del objeto pasado BlobClient. Esto establecerá , HttpPipelineURL y BlobServiceVersion que se usan para interactuar con el servicio. Tenga en cuenta que la canalización subyacente aún no debe configurarse para el cifrado o descifrado.
Si pipeline
se establece, se omiten todas las demás configuraciones, aparte de endpoint(String endpoint) y serviceVersion(BlobServiceVersion version).
Tenga en cuenta que, por motivos de seguridad, este método no copia las propiedades del CustomerProvidedKey ámbito de cifrado y del cliente proporcionado. Para establecer CPK, use customerProvidedKey(CustomerProvidedKey customerProvidedKey).
Parámetros:
Devoluciones:
blobName
public EncryptedBlobClientBuilder blobName(String blobName)
Establece el nombre del blob.
Parámetros:
Devoluciones:
buildEncryptedBlobAsyncClient
public EncryptedBlobAsyncClient buildEncryptedBlobAsyncClient()
Crea un EncryptedBlobAsyncClient objeto basado en las opciones establecidas en el Generador.
Ejemplos de código
EncryptedBlobClient client = new EncryptedBlobClientBuilder()
.key(key, keyWrapAlgorithm)
.keyResolver(keyResolver)
.connectionString(connectionString)
.containerName("<YOUR CONTAINER NAME>")
.blobName("<YOUR BLOB NAME>")
.buildEncryptedBlobClient();
Devoluciones:
buildEncryptedBlobClient
public EncryptedBlobClient buildEncryptedBlobClient()
Crea un EncryptedBlobClient objeto basado en las opciones establecidas en el Generador.
Ejemplos de código
EncryptedBlobAsyncClient client = new EncryptedBlobClientBuilder()
.key(key, keyWrapAlgorithm)
.keyResolver(keyResolver)
.connectionString(connectionString)
.containerName("<YOUR CONTAINER NAME>")
.blobName("<YOUR BLOB NAME>")
.buildEncryptedBlobAsyncClient();
Devoluciones:
clientOptions
public EncryptedBlobClientBuilder clientOptions(ClientOptions clientOptions)
Permite establecer propiedades comunes, como el identificador de aplicación, los encabezados, la configuración del proxy, etc. Tenga en cuenta que se recomienda llamar a este método con una instancia de la HttpClientOptions clase (una subclase de la ClientOptions clase base). La subclase HttpClientOptions proporciona más opciones de configuración adecuadas para los clientes HTTP, que se aplican a cualquier clase que implemente esta interfaz HttpTrait.
Nota: Es importante comprender el orden de precedencia de las API de HttpTrait. En concreto, si se especifica , HttpPipeline esto tiene prioridad sobre todas las demás API del rasgo y se omitirán. Si no se especifica ningún HttpPipeline , una canalización HTTP se construirá internamente en función de la configuración proporcionada a este rasgo. Además, puede haber otras API en tipos que implementen este rasgo que también se omiten si se especifica un HttpPipeline , por lo que asegúrese de consultar la documentación de tipos que implementan este rasgo para comprender todo el conjunto de implicaciones.
Parámetros:
Devoluciones:
configuration
public EncryptedBlobClientBuilder configuration(Configuration configuration)
Establece el objeto de configuración utilizado para recuperar los valores de configuración del entorno durante la compilación del cliente.
Parámetros:
Devoluciones:
connectionString
public EncryptedBlobClientBuilder connectionString(String connectionString)
Establece el cadena de conexión para conectarse al servicio.
Parámetros:
Devoluciones:
containerName
public EncryptedBlobClientBuilder containerName(String containerName)
Establece el nombre del contenedor que contiene el blob.
Parámetros:
null
o está vacío en el contenedor raíz, $root
se usará .
Devoluciones:
credential
public EncryptedBlobClientBuilder credential(AzureNamedKeyCredential credential)
Establece el AzureNamedKeyCredential objeto utilizado para autorizar las solicitudes enviadas al servicio.
Parámetros:
Devoluciones:
credential
public EncryptedBlobClientBuilder credential(AzureSasCredential credential)
Establece el AzureSasCredential objeto utilizado para autorizar las solicitudes enviadas al servicio.
Parámetros:
Devoluciones:
credential
public EncryptedBlobClientBuilder credential(TokenCredential credential)
Establece el TokenCredential objeto utilizado para autorizar las solicitudes enviadas al servicio. Consulte la documentación de autenticación e identidad de Azure SDK para Java para obtener más información sobre el uso adecuado del TokenCredential tipo.
Parámetros:
Devoluciones:
credential
public EncryptedBlobClientBuilder credential(StorageSharedKeyCredential credential)
Establece el StorageSharedKeyCredential objeto utilizado para autorizar las solicitudes enviadas al servicio.
Parámetros:
Devoluciones:
customerProvidedKey
public EncryptedBlobClientBuilder customerProvidedKey(CustomerProvidedKey customerProvidedKey)
Establece el CustomerProvidedKey objeto que se usa para cifrar el contenido del blob en el servidor.
Parámetros:
Devoluciones:
encryptionScope
public EncryptedBlobClientBuilder encryptionScope(String encryptionScope)
Establece el encryption scope
objeto que se usa para cifrar el contenido del blob en el servidor.
Parámetros:
Devoluciones:
endpoint
public EncryptedBlobClientBuilder endpoint(String endpoint)
Establece el punto de conexión de servicio, además lo analiza para obtener información (token de SAS, nombre de contenedor, nombre de blob)
Si el nombre del blob contiene caracteres especiales, pase la versión codificada de dirección URL del nombre del blob.
Si el punto de conexión es para un blob en el contenedor raíz, este método producirá un error, ya que interpretará el nombre del blob como el nombre del contenedor. Con solo un elemento de ruta de acceso, es imposible distinguir entre un nombre de contenedor y un blob en el contenedor raíz, por lo que se supone que es el nombre del contenedor, ya que esto es mucho más común. Al trabajar con blobs en el contenedor raíz, es mejor establecer el punto de conexión en la dirección URL de la cuenta y especificar el nombre del blob por separado mediante el blobName(String blobName) método .
Parámetros:
Devoluciones:
getDefaultHttpLogOptions
public static HttpLogOptions getDefaultHttpLogOptions()
Obtiene los encabezados de registro y los parámetros de consulta de la lista de permitidos de almacenamiento predeterminados.
Devoluciones:
httpClient
public EncryptedBlobClientBuilder httpClient(HttpClient httpClient)
Establece el HttpClient objeto que se va a usar para enviar y recibir solicitudes hacia y desde el servicio.
Nota: Es importante comprender el orden de precedencia de las API de HttpTrait. En concreto, si se especifica , HttpPipeline esto tiene prioridad sobre todas las demás API del rasgo y se omitirán. Si no se especifica ningún HttpPipeline , una canalización HTTP se construirá internamente en función de la configuración proporcionada a este rasgo. Además, puede haber otras API en tipos que implementen este rasgo que también se omiten si se especifica un HttpPipeline , por lo que asegúrese de consultar la documentación de tipos que implementan este rasgo para comprender todo el conjunto de implicaciones.
Parámetros:
Devoluciones:
httpLogOptions
public EncryptedBlobClientBuilder httpLogOptions(HttpLogOptions logOptions)
Establece el HttpLogOptions objeto que se va a usar al enviar y recibir solicitudes hacia y desde el servicio. Si no se proporciona , logLevel
se establece el valor predeterminado de HttpLogDetailLevel#NONE .
Nota: Es importante comprender el orden de precedencia de las API de HttpTrait. En concreto, si se especifica , HttpPipeline esto tiene prioridad sobre todas las demás API del rasgo y se omitirán. Si no se especifica ningún HttpPipeline , una canalización HTTP se construirá internamente en función de la configuración proporcionada a este rasgo. Además, puede haber otras API en tipos que implementen este rasgo que también se omiten si se especifica un HttpPipeline , por lo que asegúrese de consultar la documentación de tipos que implementan este rasgo para comprender todo el conjunto de implicaciones.
Parámetros:
Devoluciones:
key
public EncryptedBlobClientBuilder key(AsyncKeyEncryptionKey key, String keyWrapAlgorithm)
Establece los parámetros de clave de cifrado para el cliente.
Parámetros:
Devoluciones:
keyResolver
public EncryptedBlobClientBuilder keyResolver(AsyncKeyEncryptionKeyResolver keyResolver)
Establece los parámetros de cifrado para este cliente.
Parámetros:
Devoluciones:
pipeline
public EncryptedBlobClientBuilder pipeline(HttpPipeline httpPipeline)
Establece el objeto HttpPipeline que se va a usar para el cliente de servicio.
Nota: Es importante comprender el orden de precedencia de las API de HttpTrait. En concreto, si se especifica , HttpPipeline esto tiene prioridad sobre todas las demás API del rasgo y se omitirán. Si no se especifica ningún HttpPipeline , una canalización HTTP se construirá internamente en función de la configuración proporcionada a este rasgo. Además, puede haber otras API en tipos que implementen este rasgo que también se omiten si se especifica un HttpPipeline , por lo que asegúrese de consultar la documentación de tipos que implementan este rasgo para comprender todo el conjunto de implicaciones.
y endpoint(String endpoint)customerProvidedKey(CustomerProvidedKey customerProvidedKey) no se omiten cuando pipeline
se establece.
Parámetros:
Devoluciones:
requiresEncryption
public EncryptedBlobClientBuilder requiresEncryption(boolean requiresEncryption)
Establece la opción de cifrado requiere cifrado.
Parámetros:
Devoluciones:
retryOptions
public EncryptedBlobClientBuilder retryOptions(RetryOptions retryOptions)
Establece para RetryOptions todas las solicitudes realizadas a través del cliente.
Nota: Es importante comprender el orden de precedencia de las API de HttpTrait. En concreto, si se especifica , HttpPipeline esto tiene prioridad sobre todas las demás API del rasgo y se omitirán. Si no se especifica ningún HttpPipeline , una canalización HTTP se construirá internamente en función de la configuración proporcionada a este rasgo. Además, puede haber otras API en tipos que implementen este rasgo que también se omiten si se especifica un HttpPipeline , por lo que asegúrese de consultar la documentación de tipos que implementan este rasgo para comprender todo el conjunto de implicaciones.
Establecer esta opción es mutuamente excluyente con el uso de retryOptions(RequestRetryOptions retryOptions). Considere la posibilidad de usar retryOptions(RequestRetryOptions retryOptions) para establecer también opciones específicas de almacenamiento.
Parámetros:
Devoluciones:
retryOptions
public EncryptedBlobClientBuilder retryOptions(RequestRetryOptions retryOptions)
Establece las opciones de reintento de solicitud para todas las solicitudes realizadas a través del cliente. Establecer esta opción es mutuamente excluyente con el uso de retryOptions(RetryOptions retryOptions).
Parámetros:
Devoluciones:
sasToken
public EncryptedBlobClientBuilder sasToken(String sasToken)
Establece el token de SAS usado para autorizar las solicitudes enviadas al servicio.
Parámetros:
Devoluciones:
serviceVersion
public EncryptedBlobClientBuilder serviceVersion(BlobServiceVersion version)
Establece el BlobServiceVersion objeto que se usa al realizar solicitudes de API.
Si no se proporciona una versión de servicio, la versión del servicio que se usará será la versión de servicio más reciente conocida basada en la versión de la biblioteca cliente que se usa. Si no se especifica ninguna versión del servicio, la actualización a una versión más reciente de la biblioteca cliente tendrá el resultado de pasar a una versión de servicio más reciente.
El destino de una versión de servicio específica también puede significar que el servicio devolverá un error para las API más recientes.
Parámetros:
Devoluciones:
setAnonymousAccess
public EncryptedBlobClientBuilder setAnonymousAccess()
Borra la credencial usada para autorizar la solicitud.
Esto es para blobs a los que se puede acceder públicamente.
Devoluciones:
snapshot
public EncryptedBlobClientBuilder snapshot(String snapshot)
Establece el identificador de instantánea del blob.
Parámetros:
Devoluciones:
versionId
public EncryptedBlobClientBuilder versionId(String versionId)
Establece el identificador de versión del blob.
Parámetros:
null
para interactuar con la versión más reciente del blob.
Devoluciones:
Comentarios de Azure SDK for Java
Azure SDK for Java es un proyecto de código abierto. Seleccione un vínculo para proporcionar comentarios: