Share via

BlockBlobCommitBlockListOptions Class

Package:
com.azure.storage.blob.options
Maven Artifact:
com.azure:azure-storage-blob:12.30.1
  • java.lang.Object
    • com.azure.storage.blob.options.BlockBlobCommitBlockListOptions

public class BlockBlobCommitBlockListOptions

Extended options that may be passed when committing a block list.

Constructor Summary

Constructor Description
BlockBlobCommitBlockListOptions(List<String> base64BlockIds)

Creates a new instance of BlockBlobCommitBlockListOptions.

Method Summary

Modifier and Type Method and Description
List<String> getBase64BlockIds()

Gets the list of base64 encode Strings that specifies the block IDs to be committed.
BlobHttpHeaders getHeaders()

Gets the BlobHttpHeaders.
BlobImmutabilityPolicy getImmutabilityPolicy()

Gets the BlobImmutabilityPolicy.
Map<String,String> getMetadata()

Gets the metadata to associate with the blob.
BlobRequestConditions getRequestConditions()

Gets the BlobRequestConditions.
Map<String,String> getTags()

Gets the tags to associate with the blob.
AccessTier getTier()

Gets the AccessTier.
Boolean isLegalHold()

Gets if a legal hold should be placed on the blob.
BlockBlobCommitBlockListOptions setHeaders(BlobHttpHeaders headers)

Sets the BlobHttpHeaders.
BlockBlobCommitBlockListOptions setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy)

Sets the BlobImmutabilityPolicy.
BlockBlobCommitBlockListOptions setLegalHold(Boolean legalHold)

Sets if a legal hold should be placed on the blob.
BlockBlobCommitBlockListOptions setMetadata(Map<String,String> metadata)

Sets the metadata to associate with the blob.
BlockBlobCommitBlockListOptions setRequestConditions(BlobRequestConditions requestConditions)

Sets the BlobRequestConditions.
BlockBlobCommitBlockListOptions setTags(Map<String,String> tags)

Sets the tags to associate with the blob.
BlockBlobCommitBlockListOptions setTier(AccessTier tier)

Sets the AccessTier.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BlockBlobCommitBlockListOptions

public BlockBlobCommitBlockListOptions(List<String> base64BlockIds)

Creates a new instance of BlockBlobCommitBlockListOptions.

Parameters:

base64BlockIds - A list of base64 encode Strings that specifies the block IDs to be committed.

Method Details

getBase64BlockIds

public List<String> getBase64BlockIds()

Gets the list of base64 encode Strings that specifies the block IDs to be committed.

Returns:

A list of base64 encode Strings that specifies the block IDs to be committed.

getHeaders

public BlobHttpHeaders getHeaders()

Gets the BlobHttpHeaders.

Returns:

getImmutabilityPolicy

public BlobImmutabilityPolicy getImmutabilityPolicy()

Gets the BlobImmutabilityPolicy.

Returns:

getMetadata

public Map<String,String> getMetadata()

Gets the metadata to associate with the blob.

Returns:

The metadata to associate with the blob.

getRequestConditions

public BlobRequestConditions getRequestConditions()

Gets the BlobRequestConditions.

Returns:

getTags

public Map<String,String> getTags()

Gets the tags to associate with the blob.

Returns:

The tags to associate with the blob.

getTier

public AccessTier getTier()

Gets the AccessTier.

Returns:

isLegalHold

public Boolean isLegalHold()

Gets if a legal hold should be placed on the blob.

Returns:

If a legal hold should be placed on the blob.

setHeaders

public BlockBlobCommitBlockListOptions setHeaders(BlobHttpHeaders headers)

Sets the BlobHttpHeaders.

Parameters:

headers - BlobHttpHeaders

Returns:

The updated AppendBlobCreateOptions

setImmutabilityPolicy

public BlockBlobCommitBlockListOptions setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy)

Sets the BlobImmutabilityPolicy.

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 BlockBlobCommitBlockListOptions setLegalHold(Boolean legalHold)

Sets if a legal hold should be placed on the blob.

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 BlockBlobCommitBlockListOptions setMetadata(Map<String,String> metadata)

Sets the metadata to associate with the blob.

Parameters:

metadata - The metadata to associate with the blob.

Returns:

The updated options

setRequestConditions

public BlockBlobCommitBlockListOptions setRequestConditions(BlobRequestConditions requestConditions)

Sets the BlobRequestConditions.

Parameters:

requestConditions - BlobRequestConditions

Returns:

The updated options.

setTags

public BlockBlobCommitBlockListOptions setTags(Map<String,String> tags)

Sets the tags to associate with the blob.

Parameters:

tags - The tags to associate with the blob.

Returns:

The updated options.

setTier

public BlockBlobCommitBlockListOptions setTier(AccessTier tier)

Sets the AccessTier.

Parameters:

tier - AccessTier

Returns:

The updated options.

Applies to