BlockBlobSimpleUploadOptions Class

  • Reference
Package:
com.azure.storage.blob.options
Maven Artifact:
com.azure:azure-storage-blob:12.28.1
  • java.lang.Object
    • com.azure.storage.blob.options.BlockBlobSimpleUploadOptions

public class BlockBlobSimpleUploadOptions

Extended options that may be passed when uploading a Block Blob in a single request.

Constructor Summary

Constructor Description
BlockBlobSimpleUploadOptions(BinaryData data)
BlockBlobSimpleUploadOptions(InputStream data, long length)
BlockBlobSimpleUploadOptions(Flux<ByteBuffer> data, long length)

Method Summary

Modifier and Type Method and Description
byte[] getContentMd5()
BinaryData getData()
Flux<ByteBuffer> getDataFlux()
InputStream getDataStream()
BlobHttpHeaders getHeaders()
BlobImmutabilityPolicy getImmutabilityPolicy()
long getLength()
Map<String,String> getMetadata()
BlobRequestConditions getRequestConditions()
Map<String,String> getTags()
AccessTier getTier()
Boolean isLegalHold()
BlockBlobSimpleUploadOptions setContentMd5(byte[] contentMd5)
BlockBlobSimpleUploadOptions setHeaders(BlobHttpHeaders headers)
BlockBlobSimpleUploadOptions setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy)

Note that this parameter is only applicable to a blob within a container that has immutable storage with versioning enabled.
BlockBlobSimpleUploadOptions setLegalHold(Boolean legalHold)

Note that this parameter is only applicable to a blob within a container that has immutable storage with versioning enabled.
BlockBlobSimpleUploadOptions setMetadata(Map<String,String> metadata)
BlockBlobSimpleUploadOptions setRequestConditions(BlobRequestConditions requestConditions)
BlockBlobSimpleUploadOptions setTags(Map<String,String> tags)
BlockBlobSimpleUploadOptions setTier(AccessTier tier)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BlockBlobSimpleUploadOptions

public BlockBlobSimpleUploadOptions(BinaryData data)

Parameters:

data - The data to write to the block. Note that this BinaryData must have defined length and must be replayable if retries are enabled (the default), see BinaryData#isReplayable().

BlockBlobSimpleUploadOptions

public BlockBlobSimpleUploadOptions(InputStream data, long length)

Parameters:

data - The data to write to the blob.
length - The exact length of the data. It is important that this value match precisely the length of the data emitted by the data source.

BlockBlobSimpleUploadOptions

public BlockBlobSimpleUploadOptions(Flux data, long length)

Parameters:

data - The data to write to the blob. Note that this Flux must be replayable if retries are enabled (the default). In other words, the Flux must produce the same data each time it is subscribed to.
length - The exact length of the data. It is important that this value match precisely the length of the data emitted by the data source.

Method Details

getContentMd5

public byte[] getContentMd5()

Returns:

An MD5 hash of the content. This hash is used to verify the integrity of the content during transport. When this header is specified, the storage service compares the hash of the content that has arrived with this header value. Note that this MD5 hash is not stored with the blob. If the two hashes do not match, the operation will fail.

getData

public BinaryData getData()

Returns:

The data to write to the blob.

getDataFlux

public Flux getDataFlux()

Returns:

The data to write to the blob. Note that this Flux must be replayable if retries are enabled (the default). In other words, the Flux must produce the same data each time it is subscribed to.

getDataStream

public InputStream getDataStream()

Returns:

The data to write to the blob.

getHeaders

public BlobHttpHeaders getHeaders()

Returns:

getImmutabilityPolicy

public BlobImmutabilityPolicy getImmutabilityPolicy()

Returns:

getLength

public long getLength()

Returns:

The exact length of the data. It is important that this value match precisely the length of the data emitted by the data source.

getMetadata

public Map getMetadata()

Returns:

The metadata to associate with the blob.

getRequestConditions

public BlobRequestConditions getRequestConditions()

Returns:

getTags

public Map getTags()

Returns:

The tags to associate with the blob.

getTier

public AccessTier getTier()

Returns:

isLegalHold

public Boolean isLegalHold()

Returns:

If a legal hold should be placed on the blob.

setContentMd5

public BlockBlobSimpleUploadOptions setContentMd5(byte[] contentMd5)

Parameters:

contentMd5 - An MD5 hash of the block content. This hash is used to verify the integrity of the block during transport. When this header is specified, the storage service compares the hash of the content that has arrived with this header value. Note that this MD5 hash is not stored with the blob. If the two hashes do not match, the operation will fail.

Returns:

The updated options

setHeaders

public BlockBlobSimpleUploadOptions setHeaders(BlobHttpHeaders headers)

Parameters:

headers - BlobHttpHeaders

Returns:

The updated options

setImmutabilityPolicy

public BlockBlobSimpleUploadOptions setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy)

Note that this parameter is only applicable to a blob within a container that has immutable storage with versioning enabled.

Parameters:

immutabilityPolicy - BlobImmutabilityPolicy

Returns:

The updated options.

setLegalHold

public BlockBlobSimpleUploadOptions setLegalHold(Boolean legalHold)

Note that this parameter is only applicable to a blob within a container that has immutable storage with versioning enabled.

Parameters:

legalHold - Indicates if a legal hold should be placed on the blob.

Returns:

The updated options.

setMetadata

public BlockBlobSimpleUploadOptions setMetadata(Map metadata)

Parameters:

metadata - The metadata to associate with the blob.

Returns:

The updated options

setRequestConditions

public BlockBlobSimpleUploadOptions setRequestConditions(BlobRequestConditions requestConditions)

Parameters:

requestConditions - BlobRequestConditions

Returns:

The updated options.

setTags

public BlockBlobSimpleUploadOptions setTags(Map tags)

Parameters:

tags - The tags to associate with the blob.

Returns:

The updated options.

setTier

public BlockBlobSimpleUploadOptions setTier(AccessTier tier)

Parameters:

tier - AccessTier

Returns:

The updated options.

Applies to