EncryptedBlobClientBuilder Clase

  • java.lang.Object
    • com.azure.storage.blob.specialized.cryptography.EncryptedBlobClientBuilder

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:

Una vez establecidas todas las configuraciones en este generador, use la siguiente asignación para construir el cliente determinado:

Resumen del constructor

Constructor Description
EncryptedBlobClientBuilder()

Obsoleto

Crea una nueva instancia del Generador de clientede blobscifrados

EncryptedBlobClientBuilder(EncryptionVersion version)

Crea una nueva instancia de EncryptedBlobClientbuilder.

Resumen del método

Modificador y tipo Método y descripción
EncryptedBlobClientBuilder addPolicy(HttpPipelinePolicy pipelinePolicy)

Agrega un HttpPipelinePolicy objeto para aplicar en cada solicitud enviada.

EncryptedBlobClientBuilder blobAsyncClient(BlobAsyncClient blobAsyncClient)

Configura el generador en función del objeto pasado BlobAsyncClient.

EncryptedBlobClientBuilder blobClient(BlobClient blobClient)

Configura el generador en función del objeto pasado BlobClient.

EncryptedBlobClientBuilder blobName(String blobName)

Establece el nombre del blob.

EncryptedBlobAsyncClient buildEncryptedBlobAsyncClient()

Crea un EncryptedBlobAsyncClient objeto basado en las opciones establecidas en el Generador.

EncryptedBlobClient buildEncryptedBlobClient()

Crea un EncryptedBlobClient objeto basado en las opciones establecidas en el Generador.

EncryptedBlobClientBuilder clientOptions(ClientOptions clientOptions)

Permite establecer propiedades comunes, como el identificador de aplicación, los encabezados, la configuración del proxy, etc.

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.

EncryptedBlobClientBuilder connectionString(String connectionString)

Establece el cadena de conexión para conectarse al servicio.

EncryptedBlobClientBuilder containerName(String containerName)

Establece el nombre del contenedor que contiene el blob.

EncryptedBlobClientBuilder credential(AzureNamedKeyCredential credential)

Establece el AzureNamedKeyCredential objeto utilizado para autorizar las solicitudes enviadas al servicio.

EncryptedBlobClientBuilder credential(AzureSasCredential credential)

Establece el AzureSasCredential objeto utilizado para autorizar las solicitudes enviadas al servicio.

EncryptedBlobClientBuilder credential(TokenCredential credential)

Establece el TokenCredential objeto utilizado para autorizar las solicitudes enviadas al servicio.

EncryptedBlobClientBuilder credential(StorageSharedKeyCredential credential)

Establece el StorageSharedKeyCredential objeto utilizado para autorizar las solicitudes enviadas al servicio.

EncryptedBlobClientBuilder customerProvidedKey(CustomerProvidedKey customerProvidedKey)

Establece el CustomerProvidedKey objeto que se usa para cifrar el contenido del blob en el servidor.

EncryptedBlobClientBuilder encryptionScope(String encryptionScope)

Establece el encryption scope objeto que se usa para cifrar el contenido del blob en el servidor.

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)

static HttpLogOptions getDefaultHttpLogOptions()

Obtiene los encabezados de registro y los parámetros de consulta de la lista de permitidos de almacenamiento predeterminados.

EncryptedBlobClientBuilder httpClient(HttpClient httpClient)

Establece el HttpClient objeto que se va a usar para enviar y recibir solicitudes hacia y desde el servicio.

EncryptedBlobClientBuilder httpLogOptions(HttpLogOptions logOptions)

Establece el HttpLogOptions objeto que se va a usar al enviar y recibir solicitudes hacia y desde el servicio.

EncryptedBlobClientBuilder key(AsyncKeyEncryptionKey key, String keyWrapAlgorithm)

Establece los parámetros de clave de cifrado para el cliente.

EncryptedBlobClientBuilder keyResolver(AsyncKeyEncryptionKeyResolver keyResolver)

Establece los parámetros de cifrado para este cliente.

EncryptedBlobClientBuilder pipeline(HttpPipeline httpPipeline)

Establece el objeto HttpPipeline que se va a usar para el cliente de servicio.

EncryptedBlobClientBuilder requiresEncryption(boolean requiresEncryption)

Establece la opción de cifrado requiere cifrado.

EncryptedBlobClientBuilder retryOptions(RetryOptions retryOptions)

Establece para RetryOptions todas las solicitudes realizadas a través del cliente.

EncryptedBlobClientBuilder retryOptions(RequestRetryOptions retryOptions)

Establece las opciones de reintento de solicitud para todas las solicitudes realizadas a través del cliente.

EncryptedBlobClientBuilder sasToken(String sasToken)

Establece el token de SAS usado para autorizar las solicitudes enviadas al servicio.

EncryptedBlobClientBuilder serviceVersion(BlobServiceVersion version)

Establece el BlobServiceVersion objeto que se usa al realizar solicitudes de API.

EncryptedBlobClientBuilder setAnonymousAccess()

Borra la credencial usada para autorizar la solicitud.

EncryptedBlobClientBuilder snapshot(String snapshot)

Establece el identificador de instantánea del blob.

EncryptedBlobClientBuilder versionId(String versionId)

Establece el identificador de versión del blob.

Métodos heredados de java.lang.Object

Detalles del constructor

EncryptedBlobClientBuilder

@Deprecated
public EncryptedBlobClientBuilder()

Obsoleto

Crea una nueva instancia de EncryptedBlobClientBuilder.

EncryptedBlobClientBuilder

public EncryptedBlobClientBuilder(EncryptionVersion version)

Crea una nueva instancia de EncryptedBlobClientbuilder.

Parámetros:

version - Versión del protocolo de cifrado del lado cliente que se va a usar. Se recomienda encarecidamente que se prefiera v2 por motivos de seguridad, aunque v1 sigue siendo compatible por motivos de compatibilidad. Tenga en cuenta que incluso un cliente configurado para cifrar mediante v2 puede descifrar blobs que usan el protocolo v1.

Detalles del método

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:

pipelinePolicy - Un objeto HttpPipelinePolicy.

Devoluciones:

el objeto EncryptedBlobClientBuilder actualizado

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:

blobAsyncClient - BlobAsyncClient se usa para configurar el generador.

Devoluciones:

el objeto EncryptedBlobClientBuilder actualizado

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:

blobClient - BlobClient se usa para configurar el generador.

Devoluciones:

el objeto EncryptedBlobClientBuilder actualizado

blobName

public EncryptedBlobClientBuilder blobName(String blobName)

Establece el nombre del blob.

Parámetros:

blobName - Nombre del blob. Si el nombre del blob contiene caracteres especiales, pase la versión codificada de dirección URL del nombre del blob.

Devoluciones:

el objeto EncryptedBlobClientBuilder actualizado

buildEncryptedBlobAsyncClient

public EncryptedBlobAsyncClient buildEncryptedBlobAsyncClient()

Crea un EncryptedBlobAsyncClient objeto basado en las opciones establecidas en el Generador.

Ejemplos de código

Java
EncryptedBlobClient client = new EncryptedBlobClientBuilder()
     .key(key, keyWrapAlgorithm)
     .keyResolver(keyResolver)
     .connectionString(connectionString)
     .containerName("<YOUR CONTAINER NAME>")
     .blobName("<YOUR BLOB NAME>")
     .buildEncryptedBlobClient();

Devoluciones:

un EncryptedBlobAsyncClient objeto creado a partir de las configuraciones de este generador.

buildEncryptedBlobClient

public EncryptedBlobClient buildEncryptedBlobClient()

Crea un EncryptedBlobClient objeto basado en las opciones establecidas en el Generador.

Ejemplos de código

Java
EncryptedBlobAsyncClient client = new EncryptedBlobClientBuilder()
     .key(key, keyWrapAlgorithm)
     .keyResolver(keyResolver)
     .connectionString(connectionString)
     .containerName("<YOUR CONTAINER NAME>")
     .blobName("<YOUR BLOB NAME>")
     .buildEncryptedBlobAsyncClient();

Devoluciones:

un EncryptedBlobClient objeto creado a partir de las configuraciones de este generador.

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:

clientOptions - Instancia configurada de HttpClientOptions.

Devoluciones:

el objeto EncryptedBlobClientBuilder actualizado

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:

configuration - Almacén de configuración usado para recuperar configuraciones de entorno.

Devoluciones:

el objeto EncryptedBlobClientBuilder actualizado

connectionString

public EncryptedBlobClientBuilder connectionString(String connectionString)

Establece el cadena de conexión para conectarse al servicio.

Parámetros:

connectionString - Cadena de conexión de la cuenta de almacenamiento.

Devoluciones:

encryptedBlobClientBuilder actualizado

containerName

public EncryptedBlobClientBuilder containerName(String containerName)

Establece el nombre del contenedor que contiene el blob.

Parámetros:

containerName - Nombre del contenedor. Si el valor null o está vacío en el contenedor raíz, $rootse usará .

Devoluciones:

el objeto EncryptedBlobClientBuilder actualizado

credential

public EncryptedBlobClientBuilder credential(AzureNamedKeyCredential credential)

Establece el AzureNamedKeyCredential objeto utilizado para autorizar las solicitudes enviadas al servicio.

Parámetros:

credential - AzureNamedKeyCredential.

Devoluciones:

encryptedBlobClientBuilder actualizado

credential

public EncryptedBlobClientBuilder credential(AzureSasCredential credential)

Establece el AzureSasCredential objeto utilizado para autorizar las solicitudes enviadas al servicio.

Parámetros:

credential - AzureSasCredential se usa para autorizar las solicitudes enviadas al servicio.

Devoluciones:

encryptedBlobClientBuilder actualizado

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:

credential - TokenCredential se usa para autorizar las solicitudes enviadas al servicio.

Devoluciones:

encryptedBlobClientBuilder actualizado

credential

public EncryptedBlobClientBuilder credential(StorageSharedKeyCredential credential)

Establece el StorageSharedKeyCredential objeto utilizado para autorizar las solicitudes enviadas al servicio.

Parámetros:

Devoluciones:

encryptedBlobClientBuilder actualizado

customerProvidedKey

public EncryptedBlobClientBuilder customerProvidedKey(CustomerProvidedKey customerProvidedKey)

Establece el CustomerProvidedKey objeto que se usa para cifrar el contenido del blob en el servidor.

Parámetros:

customerProvidedKey - CustomerProvidedKey

Devoluciones:

el objeto EncryptedBlobClientBuilder actualizado

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:

encryptionScope - Ámbito de cifrado que contiene la información de la clave de cifrado.

Devoluciones:

el objeto EncryptedBlobClientBuilder actualizado

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:

endpoint - Dirección URL del servicio

Devoluciones:

el objeto EncryptedBlobClientBuilder actualizado

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:

las opciones de registro http predeterminadas.

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:

httpClient - que HttpClient se va a usar para las solicitudes.

Devoluciones:

el objeto EncryptedBlobClientBuilder actualizado

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:

logOptions - que HttpLogOptions se va a usar al enviar y recibir solicitudes hacia y desde el servicio.

Devoluciones:

el objeto EncryptedBlobClientBuilder actualizado

key

public EncryptedBlobClientBuilder key(AsyncKeyEncryptionKey key, String keyWrapAlgorithm)

Establece los parámetros de clave de cifrado para el cliente.

Parámetros:

key - Objeto de tipo AsyncKeyEncryptionKey que se usa para encapsular o desencapsular la clave de cifrado de contenido
keyWrapAlgorithm - utilizado String para encapsular la clave.

Devoluciones:

el objeto EncryptedBlobClientBuilder actualizado

keyResolver

public EncryptedBlobClientBuilder keyResolver(AsyncKeyEncryptionKeyResolver keyResolver)

Establece los parámetros de cifrado para este cliente.

Parámetros:

keyResolver - Solucionador de claves usado para seleccionar la clave correcta para descifrar los blobs existentes.

Devoluciones:

el objeto EncryptedBlobClientBuilder actualizado

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:

httpPipeline

Devoluciones:

el objeto EncryptedBlobClientBuilder actualizado

requiresEncryption

public EncryptedBlobClientBuilder requiresEncryption(boolean requiresEncryption)

Establece la opción de cifrado requiere cifrado.

Parámetros:

requiresEncryption - Si este cliente aplica el cifrado. El cliente iniciará si los datos se descargan y no se cifran.

Devoluciones:

el objeto EncryptedBlobClientBuilder actualizado

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:

retryOptions - que RetryOptions se va a usar para todas las solicitudes realizadas a través del cliente.

Devoluciones:

el objeto EncryptedBlobClientBuilder actualizado

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:

retryOptions - RequestRetryOptions.

Devoluciones:

el objeto EncryptedBlobClientBuilder actualizado.

sasToken

public EncryptedBlobClientBuilder sasToken(String sasToken)

Establece el token de SAS usado para autorizar las solicitudes enviadas al servicio.

Parámetros:

sasToken - Token de SAS que se va a usar para autenticar solicitudes. Esta cadena solo debe ser los parámetros de consulta (con o sin una dirección URL inicial "?") y no una dirección URL completa.

Devoluciones:

encryptedBlobClientBuilder actualizado

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:

version - BlobServiceVersion del servicio que se va a usar al realizar solicitudes.

Devoluciones:

el objeto EncryptedBlobClientBuilder actualizado

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:

encryptedBlobClientBuilder actualizado

snapshot

public EncryptedBlobClientBuilder snapshot(String snapshot)

Establece el identificador de instantánea del blob.

Parámetros:

snapshot - Identificador de instantánea del blob.

Devoluciones:

el objeto EncryptedBlobClientBuilder actualizado

versionId

public EncryptedBlobClientBuilder versionId(String versionId)

Establece el identificador de versión del blob.

Parámetros:

versionId - Identificador de versión del blob, pase null para interactuar con la versión más reciente del blob.

Devoluciones:

el objeto EncryptedBlobClientBuilder actualizado

Se aplica a

Azure SDK for Java

Preview