com.microsoft.windowsazure.services.blob.models

Class SetBlobPropertiesOptions

java.lang.Object

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

com.microsoft.windowsazure.services.blob.models.SetBlobPropertiesOptions

public class SetBlobPropertiesOptions
extends BlobServiceOptions

Represents the options that may be set on a setBlobProperties request. These options include an optional server timeout for the operation, the MIME content type and content encoding for the blob, the content length, the content language, the MD5 hash, a cache control value, a blob lease ID, a sequence number and sequence number action value, and any access conditions for the operation.

Constructor Summary

Constructors

Constructor and Description
SetBlobPropertiesOptions()

Method Summary

Methods

Modifier and Type	Method and Description
AccessCondition	getAccessCondition() Gets the access conditions set in this SetBlobPropertiesOptions instance.
String	getCacheControl() Gets the HTTP cache control value set in this SetBlobPropertiesOptions instance.
String	getContentEncoding() Gets the HTTP content encoding value set in this SetBlobPropertiesOptions instance.
String	getContentLanguage() Gets the HTTP content language header value set in this SetBlobPropertiesOptions instance.
Long	getContentLength() Gets the new page blob size set in this SetBlobPropertiesOptions instance.
String	getContentMD5() Gets the MD5 hash value for the blob content set in this SetBlobPropertiesOptions instance.
String	getContentType() Gets the MIME content type value set in this SetBlobPropertiesOptions instance.
String	getLeaseId() Gets the lease ID to match for the blob set in this SetBlobPropertiesOptions instance.
Long	getSequenceNumber() Gets the sequence number value set in this SetBlobPropertiesOptions instance.
String	getSequenceNumberAction() Gets the sequence number action set in this SetBlobPropertiesOptions instance.
SetBlobPropertiesOptions	setAccessCondition(AccessCondition accessCondition) Sets the access conditions for setting the properties of a blob.
SetBlobPropertiesOptions	setCacheControl(String cacheControl) Sets the optional HTTP cache control value for the blob content.
SetBlobPropertiesOptions	setContentEncoding(String contentEncoding) Sets the optional HTML content encoding value for the blob content.
SetBlobPropertiesOptions	setContentLanguage(String contentLanguage) Sets the optional HTTP content language header value for the blob content.
SetBlobPropertiesOptions	setContentLength(Long contentLength) Sets the size of a page blob to the specified size.
SetBlobPropertiesOptions	setContentMD5(String contentMD5) Sets the optional MD5 hash value for the blob content.
SetBlobPropertiesOptions	setContentType(String contentType) Sets the optional MIME content type for the blob content.
SetBlobPropertiesOptions	setLeaseId(String leaseId) Sets an optional lease ID value to match when setting properties of the blob.
SetBlobPropertiesOptions	setSequenceNumber(Long sequenceNumber) Sets the page blob sequence number.
SetBlobPropertiesOptions	setSequenceNumberAction(String sequenceNumberAction) Sets an optional sequence number action for a page blob.
SetBlobPropertiesOptions	setTimeout(Integer timeout) Sets the optional server request timeout value associated with this SetBlobPropertiesOptions instance.

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

SetBlobPropertiesOptions

public SetBlobPropertiesOptions()

Method Detail

setTimeout

public SetBlobPropertiesOptions setTimeout(Integer timeout)

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

The timeout value only affects calls made on methods where this SetBlobPropertiesOptions 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 SetBlobPropertiesOptions instance.

getContentType

public String getContentType()

Gets the MIME content type value set in this SetBlobPropertiesOptions instance.

Returns:

A String containing the MIME content type value set, if any.

setContentType

public SetBlobPropertiesOptions setContentType(String contentType)

Sets the optional MIME content type for the blob content. This value will be returned to clients in the Content-Type header of the response when the blob data or blob properties are requested. If no content type is specified, the default content type is application/octet-stream.

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

Parameters:

contentType - A String containing the MIME content type value to set.

Returns:

A reference to this SetBlobPropertiesOptions instance.

getContentLength

public Long getContentLength()

Gets the new page blob size set in this SetBlobPropertiesOptions instance.

Returns:

The new size to set for a page blob.

setContentLength

public SetBlobPropertiesOptions setContentLength(Long contentLength)

Sets the size of a page blob to the specified size. If the specified contentLength value is less than the current size of the blob, then all pages above the specified value are cleared.

This property cannot be used to change the size of a block blob. Setting this property for a block blob causes a ServiceException to be thrown.

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

Parameters:

contentLength - The new size to set for a page blob.

Returns:

A reference to this SetBlobPropertiesOptions instance.

getContentEncoding

public String getContentEncoding()

Gets the HTTP content encoding value set in this SetBlobPropertiesOptions instance.

Returns:

A String containing the HTTP content encoding value set, if any.

setContentEncoding

public SetBlobPropertiesOptions setContentEncoding(String contentEncoding)

Sets the optional HTML content encoding value for the blob content. Use this value to specify any HTTP content encodings applied to the blob, passed as a x-ms-blob-content-encoding header value to the server. This value will be returned to clients in the headers of the response when the blob data or blob properties are requested. Pass an empty value to update a blob to the default value, which will cause no content encoding header to be returned with the blob.

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

Parameters:

contentEncoding - A String containing the x-ms-blob-content-encoding header value to set.

Returns:

A reference to this SetBlobPropertiesOptions instance.

getContentLanguage

public String getContentLanguage()

Gets the HTTP content language header value set in this SetBlobPropertiesOptions instance.

Returns:

A String containing the HTTP content language header value set, if any.

setContentLanguage

public SetBlobPropertiesOptions setContentLanguage(String contentLanguage)

Sets the optional HTTP content language header value for the blob content. Use this value to specify the content language of the blob. This value will be returned to clients in the x-ms-blob-content-language header of the response when the blob data or blob properties are requested.

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

Parameters:

contentLanguage - A String containing the x-ms-blob-content-language header value to set.

Returns:

A reference to this SetBlobPropertiesOptions instance.

getContentMD5

public String getContentMD5()

Gets the MD5 hash value for the blob content set in this SetBlobPropertiesOptions instance.

Returns:

A String containing the MD5 hash value for the blob content set, if any.

setContentMD5

public SetBlobPropertiesOptions setContentMD5(String contentMD5)

Sets the optional MD5 hash value for the blob content. This value will be returned to clients in the x-ms-blob-content-md5 header value of the response when the blob data or blob properties are requested. This hash is used to verify the integrity of the blob during transport. When this header is specified, the storage service checks the hash of the content that has arrived with the one that was sent. If the two hashes do not match, the operation will fail with error code 400 (Bad Request), which will cause a ServiceException to be thrown.

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

Parameters:

contentMD5 - A String containing the MD5 hash value for the blob content to set.

Returns:

A reference to this SetBlobPropertiesOptions instance.

getCacheControl

public String getCacheControl()

Gets the HTTP cache control value set in this SetBlobPropertiesOptions instance.

Returns:

A String containing the HTTP cache control value set, if any.

setCacheControl

public SetBlobPropertiesOptions setCacheControl(String cacheControl)

Sets the optional HTTP cache control value for the blob content. The Blob service stores this value but does not use or modify it. This value will be returned to clients in the headers of the response when the blob data or blob properties are requested.

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

Parameters:

cacheControl - A String containing the HTTP cache control value to set.

Returns:

A reference to this SetBlobPropertiesOptions instance.

getSequenceNumber

public Long getSequenceNumber()

Gets the sequence number value set in this SetBlobPropertiesOptions instance.

Returns:

The sequence number to set, if any.

setSequenceNumber

public SetBlobPropertiesOptions setSequenceNumber(Long sequenceNumber)

Sets the page blob sequence number. The sequence number is a user-controlled property that you can use to track requests and manage concurrency issues. This value is optional, but is required if the sequence number action value is set to max or update.

Use the sequenceNumber parameter together with the sequence number action to update the blob's sequence number, either to the specified value or to the higher of the values specified with the request or currently stored with the blob. This header should not be specified if the sequence number action is set to increment; in this case the service automatically increments the sequence number by one.

To set the sequence number to a value of your choosing, this property must be specified on the request together with a sequence number action value of update.

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

Parameters:

sequenceNumber - The sequence number to set.

Returns:

A reference to this SetBlobPropertiesOptions instance.

getLeaseId

public String getLeaseId()

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

Returns:

A String containing the lease ID set, if any.

setLeaseId

public SetBlobPropertiesOptions setLeaseId(String leaseId)

Sets an optional lease ID value to match when setting properties 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 SetBlobPropertiesOptions instance is passed as a parameter.

Parameters:

leaseId - A String containing the lease ID to set.

Returns:

A reference to this SetBlobPropertiesOptions instance.

getSequenceNumberAction

public String getSequenceNumberAction()

Gets the sequence number action set in this SetBlobPropertiesOptions instance.

Returns:

A String containing the sequence number action set, if any.

setSequenceNumberAction

public SetBlobPropertiesOptions setSequenceNumberAction(String sequenceNumberAction)

Sets an optional sequence number action for a page blob. This value is required if a sequence number is set for the request.

The sequenceNumberAction parameter indicates how the service should modify the page blob's sequence number. Specify one of the following strings for this parameter:

• max - Sets the sequence number to be the higher of the value included with the request and the value currently stored for the blob.
• update - Sets the sequence number to the value included with the request.
• increment - Increments the value of the sequence number by 1. If specifying this option, do not set the sequence number value; doing so will cause a ServiceException to be thrown.

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

Parameters:

sequenceNumberAction - A String containing the sequence number action to set on the page blob.

Returns:

A reference to this SetBlobPropertiesOptions instance.

getAccessCondition

public AccessCondition getAccessCondition()

Gets the access conditions set in this SetBlobPropertiesOptions instance.

Returns:

An AccessCondition containing the access conditions set, if any.

setAccessCondition

public SetBlobPropertiesOptions setAccessCondition(AccessCondition accessCondition)

Sets the access conditions for setting the properties of a blob. By default, the set blob properties operation will set the properties unconditionally. Use this method to specify conditions on the ETag or last modified time value for performing the operation.

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

Parameters:

accessCondition - An AccessCondition containing the access conditions to set.

Returns:

A reference to this SetBlobPropertiesOptions instance.