Share via

BlobClientSideEncryptionOptions Class

Package:
com.azure.storage.blob.specialized.cryptography
Maven Artifact:
com.azure:azure-storage-blob-cryptography:12.31.0
  • java.lang.Object
    • com.azure.storage.blob.specialized.cryptography.BlobClientSideEncryptionOptions

public class BlobClientSideEncryptionOptions

This class contains the configuration options used to encrypt the blob content on the client side.

Constructor Summary

Constructor Description
BlobClientSideEncryptionOptions()

Creates a new instance of BlobClientSideEncryptionOptions.

Method Summary

Modifier and Type Method and Description
long getAuthenticatedRegionDataLengthInBytes()

Gets the length of the authenticated region data.
BlobClientSideEncryptionOptions setAuthenticatedRegionDataLengthInBytes(long authenticatedRegionDataLength)

Sets the authenticated region length to use when encrypting blobs.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BlobClientSideEncryptionOptions

public BlobClientSideEncryptionOptions()

Creates a new instance of BlobClientSideEncryptionOptions.

Method Details

getAuthenticatedRegionDataLengthInBytes

public long getAuthenticatedRegionDataLengthInBytes()

Gets the length of the authenticated region data.

Returns:

the length of the authenticated region data.

setAuthenticatedRegionDataLengthInBytes

public BlobClientSideEncryptionOptions setAuthenticatedRegionDataLengthInBytes(long authenticatedRegionDataLength)

Sets the authenticated region length to use when encrypting blobs.

Parameters:

authenticatedRegionDataLength - authenticatedRegionDataLength The authenticated region length in bytes to use when encrypting the blob. This value only is used when uploading blobs. Downloads use the authenticated region data length from the blob encryption metadata when decrypting blobs. Minimum value for the length is 16 bytes, and maximum is 1GB.

Returns:

the updated BlobEncryptionOptions object.

Applies to