GetBlobOptions (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.GetBlobOptions

```
public class GetBlobOptions
extends BlobServiceOptions
```
Represents the options that may be set on a getBlob request. These options include an optional server timeout for the operation, a snapshot timestamp to specify a snapshot, a blob lease ID to get a blob with an active lease, an optional start and end range for blob content to return, and any access conditions to satisfy.

Constructor Summary

Constructors
Constructor and Description

GetBlobOptions()

Constructors
Constructor and Description
`GetBlobOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.microsoft.windowsazure.core.utils.AccessConditionHeader`	`getAccessCondition()` Gets the access conditions set in this `GetBlobOptions` instance.
`String`	`getLeaseId()` Gets the lease ID to match for the blob set in this `GetBlobOptions` instance.
`Long`	`getRangeEnd()` Gets the ending byte offset value for the blob content range to return set in this `GetBlobOptions` instance.
`Long`	`getRangeStart()` Gets the beginning byte offset value of the blob content range to return set in this `GetBlobOptions` instance.
`String`	`getSnapshot()` Gets the snapshot timestamp value set in this `GetBlobOptions` instance.
`boolean`	`isComputeRangeMD5()` Reserved for future use.
`GetBlobOptions`	`setAccessCondition(com.microsoft.windowsazure.core.utils.AccessConditionHeader accessCondition)` Sets optional access conditions for getting the blob.
`GetBlobOptions`	`setComputeRangeMD5(boolean computeRangeMD5)` Reserved for future use.
`GetBlobOptions`	`setLeaseId(String leaseId)` Sets an optional lease ID value to match when getting the blob.
`GetBlobOptions`	`setRangeEnd(Long rangeEnd)` Sets an optional ending byte offset value of the blob content range to return for the request, inclusive.
`GetBlobOptions`	`setRangeStart(Long rangeStart)` Sets an optional beginning byte offset value of the blob content range to return for the request, inclusive.
`GetBlobOptions`	`setSnapshot(String snapshot)` Sets an optional snapshot timestamp value used to identify the particular snapshot of the blob to get properties, metadata, and content for.
`GetBlobOptions`	`setTimeout(Integer timeout)` Sets the optional server request timeout value associated with this `GetBlobOptions` 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
  - GetBlobOptions
```
public GetBlobOptions()
```
- Method Detail
  - setTimeout
```
public GetBlobOptions setTimeout(Integer timeout)
```
    Sets the optional server request timeout value associated with this GetBlobOptions instance.
    The timeout value only affects calls made on methods where this GetBlobOptions 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 GetBlobOptions instance.
  - getSnapshot
```
public String getSnapshot()
```
    Gets the snapshot timestamp value set in this GetBlobOptions instance.
    
    Returns:
    
    A String containing the snapshot timestamp value of the blob snapshot to get.
  - setSnapshot
```
public GetBlobOptions setSnapshot(String snapshot)
```
    Sets an optional snapshot timestamp value used to identify the particular snapshot of the blob to get properties, metadata, and content for. The snapshot timestamp value is an opaque value returned by the server to identify a snapshot. When this option is set, only the properties, metadata, and content of the snapshot are returned.
    Note that this value only affects calls made on methods where this GetBlobOptions instance is passed as a parameter.
    
    Parameters:
    
    snapshot - A String containing the snapshot timestamp value of the blob snapshot to get.
    
    Returns:
    
    A reference to this GetBlobOptions instance.
  - getLeaseId
```
public String getLeaseId()
```
    Gets the lease ID to match for the blob set in this GetBlobOptions instance.
    
    Returns:
    
    A String containing the lease ID set, if any.
  - setLeaseId
```
public GetBlobOptions setLeaseId(String leaseId)
```
    Sets an optional lease ID value to match when getting 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 GetBlobOptions instance is passed as a parameter.
    
    Parameters:
    
    leaseId - A String containing the lease ID to set.
    
    Returns:
    
    A reference to this GetBlobOptions instance.
  - isComputeRangeMD5
```
public boolean isComputeRangeMD5()
```
    Reserved for future use. Gets a flag indicating whether to return an MD5 hash for the specified range of blob content set in this GetBlobOptions instance.
    
    Returns:
    
    A flag value of true to get the MD5 hash value for the specified range, otherwise false.
  - setComputeRangeMD5
```
public GetBlobOptions setComputeRangeMD5(boolean computeRangeMD5)
```
    Reserved for future use. Sets a flag indicating whether to return an MD5 hash for the specified range of blob content.
    When the computeRangeMD5 parameter is set to true and specified together with a range less than or equal to 4 MB in size, the get blob operation response includes the MD5 hash for the range. If the computeRangeMD5 parameter is set to true and no range is specified or the range exceeds 4 MB in size, a ServiceException is thrown.
    
    Parameters:
    
    computeRangeMD5 - Reserved for future use. Set a flag value of true to get the MD5 hash value for the specified range, otherwise false.
    
    Returns:
    
    A reference to this GetBlobOptions instance.
  - getRangeStart
```
public Long getRangeStart()
```
    Gets the beginning byte offset value of the blob content range to return set in this GetBlobOptions instance.
    
    Returns:
    
    The beginning offset value in bytes for the blob content range to return.
  - setRangeStart
```
public GetBlobOptions setRangeStart(Long rangeStart)
```
    Sets an optional beginning byte offset value of the blob content range to return for the request, inclusive.
    When this value is set, the blob content beginning at the byte offset specified by the rangeStart value and ending at the range end value, inclusive, is returned in the server response to the get blob operation. If the range end is not set, the response includes blob content from the rangeStart value to the end of the blob.
    Note that this value only affects calls made on methods where this GetBlobOptions instance is passed as a parameter.
    
    Parameters:
    
    rangeStart - The beginning offset value in bytes for the blob content range to return, inclusive.
    
    Returns:
    
    A reference to this GetBlobOptions instance.
  - getRangeEnd
```
public Long getRangeEnd()
```
    Gets the ending byte offset value for the blob content range to return set in this GetBlobOptions instance.
    
    Returns:
    
    The ending offset value in bytes for the blob content range to return.
  - setRangeEnd
```
public GetBlobOptions setRangeEnd(Long rangeEnd)
```
    Sets an optional ending byte offset value of the blob content range to return for the request, inclusive.
    If the range start is not set, this value is ignored and the response includes content from the entire blob.
    Note that this value only affects calls made on methods where this GetBlobOptions instance is passed as a parameter.
    
    Parameters:
    
    rangeEnd - The ending offset value in bytes for the blob content range to return, inclusive.
    
    Returns:
    
    A reference to this GetBlobOptions instance.
  - getAccessCondition
```
public com.microsoft.windowsazure.core.utils.AccessConditionHeader getAccessCondition()
```
    Gets the access conditions set in this GetBlobOptions instance.
    
    Returns:
    
    An AccessCondition containing the access conditions set, if any.
  - setAccessCondition
```
public GetBlobOptions setAccessCondition(com.microsoft.windowsazure.core.utils.AccessConditionHeader accessCondition)
```
    Sets optional access conditions for getting the blob. The operation will return an error if the access conditions are not met.
    Note that this value only affects calls made on methods where this GetBlobOptions instance is passed as a parameter.
    
    Parameters:
    
    accessCondition - An AccessCondition containing the access conditions to set.
    
    Returns:
    
    A reference to this GetBlobOptions 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 GetBlobOptions

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

GetBlobOptions

Method Detail

setTimeout

getSnapshot

setSnapshot

getLeaseId

setLeaseId

isComputeRangeMD5

setComputeRangeMD5

getRangeStart

setRangeStart

getRangeEnd

setRangeEnd

getAccessCondition

setAccessCondition