Package com.azure.storage.blob.options

Class BlockBlobSimpleUploadOptions

java.lang.Object
com.azure.storage.blob.options.BlockBlobSimpleUploadOptions
public class BlockBlobSimpleUploadOptions extends Object
Extended options that may be passed when uploading a Block Blob in a single request.

  • Constructor Details

    • BlockBlobSimpleUploadOptions

      public BlockBlobSimpleUploadOptions(com.azure.core.util.BinaryData data)
      Creates a new instance of BlockBlobSimpleUploadOptions.
      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().
      Throws:
      NullPointerException - If data is null or data does not have defined length.

    • BlockBlobSimpleUploadOptions

      public BlockBlobSimpleUploadOptions(Flux<ByteBuffer> data, long length)
      Creates a new instance of BlockBlobSimpleUploadOptions.
      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.
      Throws:
      NullPointerException - If data is null.
      IllegalArgumentException - If length is less than 0 or greater than Long.MAX_VALUE.

    • BlockBlobSimpleUploadOptions

      public BlockBlobSimpleUploadOptions(InputStream data, long length)
      Creates a new instance of BlockBlobSimpleUploadOptions.
      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.
      Throws:
      NullPointerException - If data is null.
      IllegalArgumentException - If length is less than 0 or greater than Long.MAX_VALUE.

  • Method Details

    • getDataFlux

      public Flux<ByteBuffer> getDataFlux()
      Gets the data to write to the blob.
      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()
      Gets the data to write to the blob.
      Returns:
      The data to write to the blob.

    • getData

      public com.azure.core.util.BinaryData getData()
      Gets the data to write to the blob.
      Returns:
      The data to write to the blob.

    • getLength

      public long getLength()
      Gets the exact length of the data.
      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.

    • getHeaders

      public BlobHttpHeaders getHeaders()
      Gets the BlobHttpHeaders.
      Returns:
      BlobHttpHeaders

    • setHeaders

      public BlockBlobSimpleUploadOptions setHeaders(BlobHttpHeaders headers)
      Sets the BlobHttpHeaders.
      Parameters:
      headers - BlobHttpHeaders
      Returns:
      The updated options

    • getMetadata

      public Map<String,String> getMetadata()
      Gets the metadata to associate with the blob.
      Returns:
      The metadata to associate with the blob.

    • setMetadata

      public BlockBlobSimpleUploadOptions 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

    • getTags

      public Map<String,String> getTags()
      Gets the tags to associate with the blob.
      Returns:
      The tags to associate with the blob.

    • setTags

      public BlockBlobSimpleUploadOptions 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.

    • getTier

      public AccessTier getTier()
      Gets the AccessTier.
      Returns:
      AccessTier

    • setTier

      public BlockBlobSimpleUploadOptions setTier(AccessTier tier)
      Sets the AccessTier.
      Parameters:
      tier - AccessTier
      Returns:
      The updated options.

    • getContentMd5

      public byte[] getContentMd5()
      Gets the MD5 hash of the content.
      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.

    • setContentMd5

      public BlockBlobSimpleUploadOptions setContentMd5(byte[] contentMd5)
      Sets the MD5 hash of the content.
      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

    • getRequestConditions

      public BlobRequestConditions getRequestConditions()
      Gets the BlobRequestConditions.
      Returns:
      BlobRequestConditions

    • setRequestConditions

      public BlockBlobSimpleUploadOptions setRequestConditions(BlobRequestConditions requestConditions)
      Sets the BlobRequestConditions.
      Parameters:
      requestConditions - BlobRequestConditions
      Returns:
      The updated options.

    • getImmutabilityPolicy

      public BlobImmutabilityPolicy getImmutabilityPolicy()
      Gets the BlobImmutabilityPolicy.
      Returns:
      BlobImmutabilityPolicy

    • setImmutabilityPolicy

      public BlockBlobSimpleUploadOptions 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.

    • 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.

    • setLegalHold

      public BlockBlobSimpleUploadOptions 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.