CommitBlobBlocksOptions (Microsoft Azure SDK for Media Services 0.9.8 API)

java.lang.Object
- com.microsoft.windowsazure.services.blob.models.BlobServiceOptions
- - com.microsoft.windowsazure.services.blob.models.CommitBlobBlocksOptions

```
public class CommitBlobBlocksOptions
extends BlobServiceOptions
```
Represents the options that may be set on a commitBlobBlocks request. These options include an optional server timeout for the operation, the MIME content type and content encoding for the blob, the content language, the MD5 hash, a cache control value, blob metadata, a blob lease ID, and any access conditions for the operation.

Constructor Summary

Constructors
Constructor and Description

CommitBlobBlocksOptions()

Constructors
Constructor and Description
`CommitBlobBlocksOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CommitBlobBlocksOptions`	`addMetadata(String key, String value)` Adds a name-value pair to the blob metadata collection associated with this `CommitBlobBlocksOptions` instance.
`com.microsoft.windowsazure.core.utils.AccessConditionHeader`	`getAccessCondition()` Gets the access conditions set in this `CommitBlobBlocksOptions` instance.
`String`	`getBlobCacheControl()` Gets the HTTP cache control value set in this `CommitBlobBlocksOptions` instance.
`String`	`getBlobContentEncoding()` Gets the HTTP content encoding value set in this `CommitBlobBlocksOptions` instance.
`String`	`getBlobContentLanguage()` Gets the HTTP content language header value set in this `CommitBlobBlocksOptions` instance.
`String`	`getBlobContentMD5()` Gets the MD5 hash value for the blob content set in this `CommitBlobBlocksOptions` instance.
`String`	`getBlobContentType()` Gets the MIME content type value set in this `CommitBlobBlocksOptions` instance.
`String`	`getLeaseId()` Gets the lease ID for the blob set in this `CommitBlobBlocksOptions` instance.
`HashMap<String,String>`	`getMetadata()` Gets the blob metadata collection set in this `CommitBlobBlocksOptions` instance.
`CommitBlobBlocksOptions`	`setAccessCondition(com.microsoft.windowsazure.core.utils.AccessConditionHeader accessCondition)` Sets the access conditions for updating a blob.
`CommitBlobBlocksOptions`	`setBlobCacheControl(String blobCacheControl)` Sets the optional HTTP cache control value for the blob content.
`CommitBlobBlocksOptions`	`setBlobContentEncoding(String blobContentEncoding)` Sets the optional HTTP content encoding value for the blob content.
`CommitBlobBlocksOptions`	`setBlobContentLanguage(String blobContentLanguage)` Sets the optional HTTP content language header value for the blob content.
`CommitBlobBlocksOptions`	`setBlobContentMD5(String blobContentMD5)` Sets the optional MD5 hash value for the blob content.
`CommitBlobBlocksOptions`	`setBlobContentType(String blobContentType)` Sets the optional MIME content type for the blob content.
`CommitBlobBlocksOptions`	`setLeaseId(String leaseId)` Sets a lease ID value to match when updating the blob.
`CommitBlobBlocksOptions`	`setMetadata(HashMap<String,String> metadata)` Sets the blob metadata collection to associate with the created blob.
`CommitBlobBlocksOptions`	`setTimeout(Integer timeout)` Sets the optional server request timeout value associated with this `CommitBlobBlocksOptions` 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
  - CommitBlobBlocksOptions
```
public CommitBlobBlocksOptions()
```
- Method Detail
  - setTimeout
```
public CommitBlobBlocksOptions setTimeout(Integer timeout)
```
    Sets the optional server request timeout value associated with this CommitBlobBlocksOptions instance.
    The timeout value only affects calls made on methods where this CommitBlobBlocksOptions 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 CommitBlobBlocksOptions instance.
  - getBlobContentType
```
public String getBlobContentType()
```
    Gets the MIME content type value set in this CommitBlobBlocksOptions instance.
    
    Returns:
    
    A String containing the MIME content type value set, if any.
  - setBlobContentType
```
public CommitBlobBlocksOptions setBlobContentType(String blobContentType)
```
    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 CommitBlobBlocksOptions instance is passed as a parameter.
    
    Parameters:
    
    blobContentType - A String containing the MIME content type value to set.
    
    Returns:
    
    A reference to this CommitBlobBlocksOptions instance.
  - getBlobContentEncoding
```
public String getBlobContentEncoding()
```
    Gets the HTTP content encoding value set in this CommitBlobBlocksOptions instance.
    
    Returns:
    
    A String containing the HTTP content encoding value set, if any.
  - setBlobContentEncoding
```
public CommitBlobBlocksOptions setBlobContentEncoding(String blobContentEncoding)
```
    Sets the optional HTTP 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 CommitBlobBlocksOptions instance is passed as a parameter.
    
    Parameters:
    
    blobContentEncoding - A String containing the x-ms-blob-content-encoding header value to set.
    
    Returns:
    
    A reference to this CommitBlobBlocksOptions instance.
  - getBlobContentLanguage
```
public String getBlobContentLanguage()
```
    Gets the HTTP content language header value set in this CommitBlobBlocksOptions instance.
    
    Returns:
    
    A String containing the HTTP content language header value set, if any.
  - setBlobContentLanguage
```
public CommitBlobBlocksOptions setBlobContentLanguage(String blobContentLanguage)
```
    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 CommitBlobBlocksOptions instance is passed as a parameter.
    
    Parameters:
    
    blobContentLanguage - A String containing the x-ms-blob-content-language header value to set.
    
    Returns:
    
    A reference to this CommitBlobBlocksOptions instance.
  - getBlobContentMD5
```
public String getBlobContentMD5()
```
    Gets the MD5 hash value for the blob content set in this CommitBlobBlocksOptions instance.
    
    Returns:
    
    A String containing the MD5 hash value for the blob content set, if any.
  - setBlobContentMD5
```
public CommitBlobBlocksOptions setBlobContentMD5(String blobContentMD5)
```
    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 CommitBlobBlocksOptions instance is passed as a parameter.
    
    Parameters:
    
    blobContentMD5 - A String containing the MD5 hash value for the blob content to set.
    
    Returns:
    
    A reference to this CommitBlobBlocksOptions instance.
  - getBlobCacheControl
```
public String getBlobCacheControl()
```
    Gets the HTTP cache control value set in this CommitBlobBlocksOptions instance.
    
    Returns:
    
    A String containing the HTTP cache control value set, if any.
  - setBlobCacheControl
```
public CommitBlobBlocksOptions setBlobCacheControl(String blobCacheControl)
```
    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 CommitBlobBlocksOptions instance is passed as a parameter.
    
    Parameters:
    
    blobCacheControl - A String containing the HTTP cache control value to set.
    
    Returns:
    
    A reference to this CommitBlobBlocksOptions instance.
  - getMetadata
```
public HashMap<String,String> getMetadata()
```
    Gets the blob metadata collection set in this CommitBlobBlocksOptions instance.
    
    Returns:
    
    A HashMap of name-value pairs of String containing the blob metadata set, if any.
  - setMetadata
```
public CommitBlobBlocksOptions setMetadata(HashMap<String,String> metadata)
```
    Sets the blob metadata collection to associate with the created blob. Metadata is a collection of name-value String pairs for client use and is opaque to the server. Metadata names must adhere to the naming rules for C# identifiers.
    The metadata value only affects calls made on methods where this CommitBlobBlocksOptions instance is passed as a parameter.
    
    Parameters:
    
    metadata - A HashMap of name-value pairs of String containing the blob metadata to set.
    
    Returns:
    
    A reference to this CommitBlobBlocksOptions instance.
  - addMetadata
```
public CommitBlobBlocksOptions addMetadata(String key,
                                           String value)
```
    Adds a name-value pair to the blob metadata collection associated with this CommitBlobBlocksOptions instance.
    
    Parameters:
    
    key - A String containing the name portion of the name-value pair to add to the metadata collection.
    
    value - A String containing the value portion of the name-value pair to add to the metadata collection.
    
    Returns:
    
    A reference to this CommitBlobBlocksOptions instance.
  - getLeaseId
```
public String getLeaseId()
```
    Gets the lease ID for the blob set in this CommitBlobBlocksOptions instance.
    
    Returns:
    
    A String containing the lease ID set, if any.
  - setLeaseId
```
public CommitBlobBlocksOptions setLeaseId(String leaseId)
```
    Sets a lease ID value to match when updating the blob. If the blob has a lease, this parameter must be set with the matching leaseId value for the commit block blobs operation to succeed.
    The leaseId value only affects calls made on methods where this CommitBlobBlocksOptions instance is passed as a parameter.
    
    Parameters:
    
    leaseId - A String containing the lease ID to set.
    
    Returns:
    
    A reference to this CommitBlobBlocksOptions instance.
  - getAccessCondition
```
public com.microsoft.windowsazure.core.utils.AccessConditionHeader getAccessCondition()
```
    Gets the access conditions set in this CommitBlobBlocksOptions instance.
    
    Returns:
    
    An AccessCondition containing the access conditions set, if any.
  - setAccessCondition
```
public CommitBlobBlocksOptions setAccessCondition(com.microsoft.windowsazure.core.utils.AccessConditionHeader accessCondition)
```
    Sets the access conditions for updating a blob. By default, the commit block blobs operation will set the container metadata unconditionally. Use this method to specify conditions on the ETag or last modified time value for performing the commit block blobs operation.
    The accessCondition value only affects calls made on methods where this CommitBlobBlocksOptions instance is passed as a parameter.
    
    Parameters:
    
    accessCondition - An AccessCondition containing the access conditions to set.
    
    Returns:
    
    A reference to this CommitBlobBlocksOptions instance.

/** 
* 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 CommitBlobBlocksOptions

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

CommitBlobBlocksOptions

Method Detail

setTimeout

getBlobContentType

setBlobContentType

getBlobContentEncoding

setBlobContentEncoding

getBlobContentLanguage

setBlobContentLanguage

getBlobContentMD5

setBlobContentMD5

getBlobCacheControl

setBlobCacheControl

getMetadata

setMetadata

addMetadata

getLeaseId

setLeaseId

getAccessCondition

setAccessCondition