CloudPageBlob (Microsoft Azure Storage Client SDK 2.2.0 API)

java.lang.Object
- com.microsoft.azure.storage.blob.CloudBlob
- - com.microsoft.azure.storage.blob.CloudPageBlob

All Implemented Interfaces:

ListBlobItem
```
public final class CloudPageBlob
extends CloudBlob
```
Represents a Microsoft Azure page blob.

Field Summary
- Fields inherited from class com.microsoft.azure.storage.blob.CloudBlob
  blobServiceClient, parent, streamMinimumReadSizeInBytes, streamWriteSizeInBytes

Constructor Summary

Constructors
Constructor and Description
`CloudPageBlob(CloudPageBlob otherBlob)` Creates an instance of the `CloudPageBlob` class by copying values from another page blob.
`CloudPageBlob(StorageUri blobAbsoluteUri)` Creates an instance of the `CloudPageBlob` class using the specified absolute URI and storage service client.
`CloudPageBlob(StorageUri blobAbsoluteUri, CloudBlobClient client)` Creates an instance of the `CloudPageBlob` class using the specified URI and cloud blob client.
`CloudPageBlob(StorageUri blobAbsoluteUri, CloudBlobClient client, CloudBlobContainer container)` Creates an instance of the `CloudPageBlob` class using the specified URI, cloud blob client, and cloud blob container.
`CloudPageBlob(StorageUri blobAbsoluteUri, String snapshotID, CloudBlobClient client)` Creates an instance of the `CloudPageBlob` class using the specified URI, snapshot ID, and cloud blob client.
`CloudPageBlob(URI blobAbsoluteUri)` Creates an instance of the `CloudPageBlob` class using the specified absolute URI and storage service client.
`CloudPageBlob(URI blobAbsoluteUri, CloudBlobClient client)` Creates an instance of the `CloudPageBlob` class using the specified URI and cloud blob client.
`CloudPageBlob(URI blobAbsoluteUri, CloudBlobClient client, CloudBlobContainer container)` Creates an instance of the `CloudPageBlob` class using the specified URI, cloud blob client, and cloud blob container.
`CloudPageBlob(URI blobAbsoluteUri, String snapshotID, CloudBlobClient client)` Creates an instance of the `CloudPageBlob` class using the specified URI, snapshot ID, and cloud blob client.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clearPages(long offset, long length)` Clears pages from a page blob.
`void`	`clearPages(long offset, long length, AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)` Clears pages from a page blob using the specified lease ID, request options, and operation context.
`void`	`create(long length)` Creates a page blob.
`void`	`create(long length, AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)` Creates a page blob using the specified request options and operation context.
`ArrayList<PageRange>`	`downloadPageRanges()` Returns a collection of page ranges and their starting and ending byte offsets.
`ArrayList<PageRange>`	`downloadPageRanges(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)` Returns a collection of page ranges and their starting and ending byte offsets using the specified request options and operation context.
`BlobOutputStream`	`openWriteExisting()` Opens an output stream object to write data to the page blob.
`BlobOutputStream`	`openWriteExisting(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)` Opens an output stream object to write data to the page blob, using the specified lease ID, request options and operation context.
`BlobOutputStream`	`openWriteNew(long length)` Opens an output stream object to write data to the page blob.
`BlobOutputStream`	`openWriteNew(long length, AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)` Opens an output stream object to write data to the page blob, using the specified lease ID, request options and operation context.
`void`	`resize(long size)` Resizes the page blob to the specified size.
`void`	`resize(long size, AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)` Resizes the page blob to the specified size.
`void`	`setStreamWriteSizeInBytes(int streamWriteSizeInBytes)` Sets the number of bytes to buffer when writing to a `BlobOutputStream`.
`protected void`	`updateSequenceNumberFromResponse(HttpURLConnection request)`
`void`	`upload(InputStream sourceStream, long length)` Uploads the source stream data to the page blob.
`void`	`upload(InputStream sourceStream, long length, AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)` Uploads the source stream data to the page blob using the specified lease ID, request options, and operation context.
`void`	`uploadPages(InputStream sourceStream, long offset, long length)` Uploads a range of contiguous pages, up to 4 MB in size, at the specified offset in the page blob.
`void`	`uploadPages(InputStream sourceStream, long offset, long length, AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)` Uploads a range of contiguous pages, up to 4 MB in size, at the specified offset in the page blob, using the specified lease ID, request options, and operation context.

Methods inherited from class com.microsoft.azure.storage.blob.CloudBlob
abortCopy, abortCopy, acquireLease, acquireLease, assertCorrectBlobType, assertNoWriteOperationForSnapshot, breakLease, breakLease, changeLease, changeLease, createSnapshot, createSnapshot, createSnapshot, delete, delete, deleteIfExists, deleteIfExists, download, download, downloadAttributes, downloadAttributes, downloadRange, downloadRange, downloadRangeInternal, downloadRangeToByteArray, downloadRangeToByteArray, downloadToByteArray, downloadToByteArray, downloadToFile, downloadToFile, exists, exists, generateSharedAccessSignature, generateSharedAccessSignature, getContainer, getCopyState, getMetadata, getName, getParent, getParentNameFromURI, getProperties, getQualifiedStorageUri, getQualifiedUri, getServiceClient, getSnapshotID, getStorageUri, getStreamMinimumReadSizeInBytes, getStreamWriteSizeInBytes, getTransformedAddress, getUri, isSnapshot, openInputStream, openInputStream, parseURIQueryStringAndVerify, releaseLease, releaseLease, renewLease, renewLease, setContainer, setMetadata, setProperties, setSnapshotID, setStorageUri, setStreamMinimumReadSizeInBytes, startCopyFromBlob, startCopyFromBlob, startCopyFromBlob, startCopyFromBlob, updateEtagAndLastModifiedFromResponse, updateLengthFromResponse, uploadFromByteArray, uploadFromByteArray, uploadFromFile, uploadFromFile, uploadMetadata, uploadMetadata, uploadProperties, uploadProperties

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CloudPageBlob
```
public CloudPageBlob(URI blobAbsoluteUri)
              throws StorageException
```
    Creates an instance of the CloudPageBlob class using the specified absolute URI and storage service client.
    
    Parameters:
    blobAbsoluteUri - A java.net.URI object which represents the absolute URI to the blob.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - CloudPageBlob
```
public CloudPageBlob(StorageUri blobAbsoluteUri)
              throws StorageException
```
    Creates an instance of the CloudPageBlob class using the specified absolute URI and storage service client.
    
    Parameters:
    blobAbsoluteUri - A StorageUri object which represents the absolute URI to the blob.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - CloudPageBlob
```
public CloudPageBlob(CloudPageBlob otherBlob)
```
    Creates an instance of the CloudPageBlob class by copying values from another page blob.
    
    Parameters:
    otherBlob - A CloudPageBlob object which represents the page blob to copy.
  - CloudPageBlob
```
public CloudPageBlob(URI blobAbsoluteUri,
             CloudBlobClient client)
              throws StorageException
```
    Creates an instance of the CloudPageBlob class using the specified URI and cloud blob client.
    
    Parameters:
    blobAbsoluteUri - A java.net.URI object which represents the absolute URI to the blob.
    client - A CloudBlobClient object that specifies the endpoint for the Blob service.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - CloudPageBlob
```
public CloudPageBlob(StorageUri blobAbsoluteUri,
             CloudBlobClient client)
              throws StorageException
```
    Creates an instance of the CloudPageBlob class using the specified URI and cloud blob client.
    
    Parameters:
    blobAbsoluteUri - A StorageUri object which represents the absolute URI to the blob.
    client - A CloudBlobClient object that specifies the endpoint for the Blob service.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - CloudPageBlob
```
public CloudPageBlob(URI blobAbsoluteUri,
             CloudBlobClient client,
             CloudBlobContainer container)
              throws StorageException
```
    Creates an instance of the CloudPageBlob class using the specified URI, cloud blob client, and cloud blob container.
    
    Parameters:
    blobAbsoluteUri - A java.net.URI object which represents the absolute URI to the blob.
    client - A CloudBlobClient object that specifies the endpoint for the Blob service.
    container - A CloudBlobContainer object which represents the container to use for the blob.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - CloudPageBlob
```
public CloudPageBlob(StorageUri blobAbsoluteUri,
             CloudBlobClient client,
             CloudBlobContainer container)
              throws StorageException
```
    Creates an instance of the CloudPageBlob class using the specified URI, cloud blob client, and cloud blob container.
    
    Parameters:
    blobAbsoluteUri - A StorageUri object which represents the absolute URI to the blob.
    client - A CloudBlobClient object that specifies the endpoint for the Blob service.
    container - A CloudBlobContainer object which represents the container to use for the blob.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - CloudPageBlob
```
public CloudPageBlob(URI blobAbsoluteUri,
             String snapshotID,
             CloudBlobClient client)
              throws StorageException
```
    Creates an instance of the CloudPageBlob class using the specified URI, snapshot ID, and cloud blob client.
    
    Parameters:
    blobAbsoluteUri - A java.net.URI object which represents the absolute URI to the blob.
    snapshotID - A String which represents the snapshot version, if applicable.
    client - A CloudBlobContainer object which represents the container to use for the blob.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - CloudPageBlob
```
public CloudPageBlob(StorageUri blobAbsoluteUri,
             String snapshotID,
             CloudBlobClient client)
              throws StorageException
```
    Creates an instance of the CloudPageBlob class using the specified URI, snapshot ID, and cloud blob client.
    
    Parameters:
    blobAbsoluteUri - A StorageUri object which represents the absolute URI to the blob.
    snapshotID - A String which represents the snapshot version, if applicable.
    client - A CloudBlobContainer object which represents the container to use for the blob.
    
    Throws:
    
    StorageException - If a storage service error occurred.
- Method Detail
  - clearPages
```
@DoesServiceRequest
public void clearPages(long offset,
                                 long length)
                throws StorageException
```
    Clears pages from a page blob.
    Calling clearPages releases the storage space used by the specified pages. Pages that have been cleared are no longer tracked as part of the page blob, and no longer incur a charge against the storage account.
    
    Parameters:
    offset - The offset, in bytes, at which to begin clearing pages. This value must be a multiple of 512.
    length - The length, in bytes, of the data range to be cleared. This value must be a multiple of 512.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - clearPages
```
@DoesServiceRequest
public void clearPages(long offset,
                                 long length,
                                 AccessCondition accessCondition,
                                 BlobRequestOptions options,
                                 OperationContext opContext)
                throws StorageException
```
    Clears pages from a page blob using the specified lease ID, request options, and operation context.
    Calling clearPages releases the storage space used by the specified pages. Pages that have been cleared are no longer tracked as part of the page blob, and no longer incur a charge against the storage account.
    
    Parameters:
    offset - A long which represents the offset, in bytes, at which to begin clearing pages. This value must be a multiple of 512.
    length - A long which represents the length, in bytes, of the data range to be cleared. This value must be a multiple of 512.
    accessCondition - An AccessCondition object which represents the access conditions for the blob.
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).
    opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - create
```
@DoesServiceRequest
public void create(long length)
            throws StorageException
```
    Creates a page blob.
    
    Parameters:
    length - A long which represents the size, in bytes, of the page blob.
    
    Throws:
    
    IllegalArgumentException - If the length is not a multiple of 512.
    
    StorageException - If a storage service error occurred.
  - create
```
@DoesServiceRequest
public void create(long length,
                             AccessCondition accessCondition,
                             BlobRequestOptions options,
                             OperationContext opContext)
            throws StorageException
```
    Creates a page blob using the specified request options and operation context.
    
    Parameters:
    length - A long which represents the size, in bytes, of the page blob.
    accessCondition - An AccessCondition object which represents the access conditions for the blob.
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).
    opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    IllegalArgumentException - If the length is not a multiple of 512.
    
    StorageException - If a storage service error occurred.
  - downloadPageRanges
```
@DoesServiceRequest
public ArrayList<PageRange> downloadPageRanges()
                                        throws StorageException
```
    Returns a collection of page ranges and their starting and ending byte offsets.
    The start and end byte offsets for each page range are inclusive.
    
    Returns:
    An ArrayList object which represents the set of page ranges and their starting and ending byte offsets.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - downloadPageRanges
```
@DoesServiceRequest
public ArrayList<PageRange> downloadPageRanges(AccessCondition accessCondition,
                                                         BlobRequestOptions options,
                                                         OperationContext opContext)
                                        throws StorageException
```
    Returns a collection of page ranges and their starting and ending byte offsets using the specified request options and operation context.
    
    Parameters:
    accessCondition - An AccessCondition object which represents the access conditions for the blob.
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).
    opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Returns:
    An ArrayList object which represents the set of page ranges and their starting and ending byte offsets.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - openWriteExisting
```
@DoesServiceRequest
public BlobOutputStream openWriteExisting()
                                   throws StorageException
```
    Opens an output stream object to write data to the page blob. The page blob must already exist.
    
    Returns:
    A BlobOutputStream object used to write data to the blob.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - openWriteExisting
```
@DoesServiceRequest
public BlobOutputStream openWriteExisting(AccessCondition accessCondition,
                                                    BlobRequestOptions options,
                                                    OperationContext opContext)
                                   throws StorageException
```
    Opens an output stream object to write data to the page blob, using the specified lease ID, request options and operation context. The page blob must already exist.
    
    Parameters:
    accessCondition - An AccessCondition object which represents the access conditions for the blob.
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).
    opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Returns:
    A BlobOutputStream object used to write data to the blob.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - openWriteNew
```
@DoesServiceRequest
public BlobOutputStream openWriteNew(long length)
                              throws StorageException
```
    Opens an output stream object to write data to the page blob. The page blob does not need to yet exist and will be created with the length specified.
    
    Parameters:
    length - A long which represents the length, in bytes, of the stream to create. This value must be a multiple of 512.
    
    Returns:
    A BlobOutputStream object used to write data to the blob.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - openWriteNew
```
@DoesServiceRequest
public BlobOutputStream openWriteNew(long length,
                                               AccessCondition accessCondition,
                                               BlobRequestOptions options,
                                               OperationContext opContext)
                              throws StorageException
```
    Opens an output stream object to write data to the page blob, using the specified lease ID, request options and operation context. The page blob does not need to yet exist and will be created with the length specified.
    
    Parameters:
    length - A long which represents the length, in bytes, of the stream to create. This value must be a multiple of 512.
    accessCondition - An AccessCondition object which represents the access conditions for the blob.
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).
    opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Returns:
    A BlobOutputStream object used to write data to the blob.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - updateSequenceNumberFromResponse
```
protected void updateSequenceNumberFromResponse(HttpURLConnection request)
```
  - resize
```
public void resize(long size)
            throws StorageException
```
    Resizes the page blob to the specified size.
    
    Parameters:
    size - A long which represents the size of the page blob, in bytes.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - resize
```
public void resize(long size,
          AccessCondition accessCondition,
          BlobRequestOptions options,
          OperationContext opContext)
            throws StorageException
```
    Resizes the page blob to the specified size.
    
    Parameters:
    size - A long which represents the size of the page blob, in bytes.
    accessCondition - An AccessCondition object which represents the access conditions for the blob.
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).
    opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - upload
```
@DoesServiceRequest
public void upload(InputStream sourceStream,
                             long length)
            throws StorageException,
                   IOException
```
    Uploads the source stream data to the page blob.
    
    Specified by:
    
    upload in class CloudBlob
    
    Parameters:
    sourceStream - An IntputStream object to read from.
    length - A long which represents the length, in bytes, of the stream data, must be non zero and a multiple of 512.
    
    Throws:
    
    IOException - If an I/O exception occurred.
    
    StorageException - If a storage service error occurred.
  - upload
```
@DoesServiceRequest
public void upload(InputStream sourceStream,
                             long length,
                             AccessCondition accessCondition,
                             BlobRequestOptions options,
                             OperationContext opContext)
            throws StorageException,
                   IOException
```
    Uploads the source stream data to the page blob using the specified lease ID, request options, and operation context.
    
    Specified by:
    
    upload in class CloudBlob
    
    Parameters:
    sourceStream - An IntputStream object to read from.
    length - A long which represents the length, in bytes, of the stream data. This must be great than zero and a multiple of 512.
    accessCondition - An AccessCondition object which represents the access conditions for the blob.
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).
    opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    IOException - If an I/O exception occurred.
    
    StorageException - If a storage service error occurred.
  - uploadPages
```
@DoesServiceRequest
public void uploadPages(InputStream sourceStream,
                                  long offset,
                                  long length)
                 throws StorageException,
                        IOException
```
    Uploads a range of contiguous pages, up to 4 MB in size, at the specified offset in the page blob.
    
    Parameters:
    sourceStream - An IntputStream object which represents the input stream to write to the page blob.
    offset - A long which represents the offset, in number of bytes, at which to begin writing the data. This value must be a multiple of 512.
    length - A long which represents the length, in bytes, of the data to write. This value must be a multiple of 512.
    
    Throws:
    
    IllegalArgumentException - If the offset or length are not multiples of 512, or if the length is greater than 4 MB.
    
    IOException - If an I/O exception occurred.
    
    StorageException - If a storage service error occurred.
  - uploadPages
```
@DoesServiceRequest
public void uploadPages(InputStream sourceStream,
                                  long offset,
                                  long length,
                                  AccessCondition accessCondition,
                                  BlobRequestOptions options,
                                  OperationContext opContext)
                 throws StorageException,
                        IOException
```
    Uploads a range of contiguous pages, up to 4 MB in size, at the specified offset in the page blob, using the specified lease ID, request options, and operation context.
    
    Parameters:
    sourceStream - An IntputStream object which represents the input stream to write to the page blob.
    offset - A long which represents the offset, in number of bytes, at which to begin writing the data. This value must be a multiple of 512.
    length - A long which represents the length, in bytes, of the data to write. This value must be a multiple of 512.
    accessCondition - An AccessCondition object which represents the access conditions for the blob.
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).
    opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    IllegalArgumentException - If the offset or length are not multiples of 512, or if the length is greater than 4 MB.
    
    IOException - If an I/O exception occurred.
    
    StorageException - If a storage service error occurred.
  - setStreamWriteSizeInBytes
```
public void setStreamWriteSizeInBytes(int streamWriteSizeInBytes)
```
    Sets the number of bytes to buffer when writing to a BlobOutputStream.
    
    Specified by:
    
    setStreamWriteSizeInBytes in class CloudBlob
    
    Parameters:
    pageBlobStreamWriteSizeInBytes - An int which represents the maximum number of bytes to buffer when writing to a page blob stream. This value must be a multiple of 512 and less than or equal to 4 MB.
    
    Throws:
    
    IllegalArgumentException - If streamWriteSizeInBytes is less than 512, greater than 4 MB, or not a multiple or 512.

/** 
* Copyright Microsoft Corporation 
* 
* Licensed under the Apache License, Version 2.0 (the "License"); 
* you may not use this file except in compliance with the License. 
* You may obtain a copy of the License at 
* http://www.apache.org/licenses/LICENSE-2.0 
* 
* Unless required by applicable law or agreed to in writing, software 
* distributed under the License is distributed on an "AS IS" BASIS, 
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
* See the License for the specific language governing permissions and 
* limitations under the License. 
*/

Class CloudPageBlob

Field Summary

Fields inherited from class com.microsoft.azure.storage.blob.CloudBlob

Constructor Summary

Method Summary

Methods inherited from class com.microsoft.azure.storage.blob.CloudBlob

Methods inherited from class java.lang.Object

Constructor Detail

CloudPageBlob

CloudPageBlob

CloudPageBlob

CloudPageBlob

CloudPageBlob

CloudPageBlob

CloudPageBlob

CloudPageBlob

CloudPageBlob

Method Detail

clearPages

clearPages

create

create

downloadPageRanges

downloadPageRanges

openWriteExisting

openWriteExisting

openWriteNew

openWriteNew

updateSequenceNumberFromResponse

resize

resize

upload

upload

uploadPages

uploadPages

setStreamWriteSizeInBytes