com.microsoft.windowsazure.services.blob.models

Class ListBlobBlocksOptions

java.lang.Object

com.microsoft.windowsazure.services.blob.models.BlobServiceOptions

com.microsoft.windowsazure.services.blob.models.ListBlobBlocksOptions

public class ListBlobBlocksOptions
extends BlobServiceOptions

Represents the options that may be set on a listBlobBlocks request. These options include an optional server timeout for the operation, the lease ID if the blob has an active lease, the snapshot timestamp to get the committed blocks of a snapshot, whether to return the committed block list, and whether to return the uncommitted block list.

Constructor Summary

Constructors

Constructor and Description
ListBlobBlocksOptions()

Method Summary

Modifier and Type	Method and Description
String	getLeaseId() Gets the lease ID to match for the blob set in this ListBlobBlocksOptions instance.
String	getSnapshot() Gets the snapshot timestamp value set in this ListBlobBlocksOptions instance.
boolean	isCommittedList() Gets the flag value indicating whether to return the committed blocks of the blob set in this ListBlobBlocksOptions instance.
boolean	isUncommittedList() Gets the flag value indicating whether to return the uncommitted blocks of the blob set in this ListBlobBlocksOptions instance.
ListBlobBlocksOptions	setCommittedList(boolean committedList) Sets a flag indicating whether to return the committed blocks of the blob in the response to the list blob blocks request.
ListBlobBlocksOptions	setLeaseId(String leaseId) Sets a lease ID value to match when listing the blocks of the blob.
ListBlobBlocksOptions	setSnapshot(String snapshot) Sets the snapshot timestamp value used to identify the particular snapshot of the blob to list blocks for.
ListBlobBlocksOptions	setTimeout(Integer timeout) Sets the optional server request timeout value associated with this ListBlobBlocksOptions instance.
ListBlobBlocksOptions	setUncommittedList(boolean uncommittedList) Sets a flag indicating whether to return the uncommitted blocks of the blob in the response to the list blob blocks request.

Methods inherited from class com.microsoft.windowsazure.services.blob.models.BlobServiceOptions

getTimeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListBlobBlocksOptions

public ListBlobBlocksOptions()

Method Detail

setTimeout

public ListBlobBlocksOptions setTimeout(Integer timeout)

Sets the optional server request timeout value associated with this ListBlobBlocksOptions instance.

The timeout value only affects calls made on methods where this ListBlobBlocksOptions instance is passed as a parameter.

Overrides:

setTimeout in class BlobServiceOptions

Parameters:

timeout - The server request timeout value to set in milliseconds.

Returns:

A reference to this ListBlobBlocksOptions instance.

getLeaseId

public String getLeaseId()

Gets the lease ID to match for the blob set in this ListBlobBlocksOptions instance.

Returns:

A String containing the lease ID set, if any.

setLeaseId

public ListBlobBlocksOptions setLeaseId(String leaseId)

Sets a lease ID value to match when listing the blocks of the blob. If set, the lease must be active and the value must match the lease ID set on the leased blob for the operation to succeed.

Note that this value only affects calls made on methods where this ListBlobBlocksOptions instance is passed as a parameter.

Parameters:

leaseId - A String containing the lease ID to set.

Returns:

A reference to this ListBlobBlocksOptions instance.

getSnapshot

public String getSnapshot()

Gets the snapshot timestamp value set in this ListBlobBlocksOptions instance.

Returns:

A String containing the snapshot timestamp value of the blob snapshot to list.

setSnapshot

public ListBlobBlocksOptions setSnapshot(String snapshot)

Sets the snapshot timestamp value used to identify the particular snapshot of the blob to list blocks for. The snapshot timestamp value is an opaque value returned by the server to identify a snapshot. When this option is set, only the list of committed blocks of the snapshot is returned.

Note that this value only affects calls made on methods where this ListBlobBlocksOptions instance is passed as a parameter.

Parameters:

snapshot - A String containing the snapshot timestamp value of the blob snapshot to list.

Returns:

A reference to this ListBlobBlocksOptions instance.

isCommittedList

public boolean isCommittedList()

Gets the flag value indicating whether to return the committed blocks of the blob set in this ListBlobBlocksOptions instance.

Returns:

A boolean flag value indicating whether to return the committed blocks of the blob.

setCommittedList

public ListBlobBlocksOptions setCommittedList(boolean committedList)

Sets a flag indicating whether to return the committed blocks of the blob in the response to the list blob blocks request.

Note that this value only affects calls made on methods where this ListBlobBlocksOptions instance is passed as a parameter.

Parameters:

committedList - Set to true to return the committed blocks of the blob; otherwise, false.

Returns:

A reference to this ListBlobBlocksOptions instance.

isUncommittedList

public boolean isUncommittedList()

Gets the flag value indicating whether to return the uncommitted blocks of the blob set in this ListBlobBlocksOptions instance.

Returns:

A boolean flag value indicating whether to return the uncommitted blocks of the blob.

setUncommittedList

public ListBlobBlocksOptions setUncommittedList(boolean uncommittedList)

Sets a flag indicating whether to return the uncommitted blocks of the blob in the response to the list blob blocks request.

Note that this value only affects calls made on methods where this ListBlobBlocksOptions instance is passed as a parameter.

Parameters:

uncommittedList - Set to true to return the uncommitted blocks of the blob; otherwise, false.

Returns:

A reference to this ListBlobBlocksOptions instance.