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

```
public class ListBlobRegionsOptions
extends BlobServiceOptions
```
Represents the options that may be set on a listBlobRegions 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 valid page ranges of a snapshot, the start offset and/or end offset to use to narrow the returned valid page range results, and any access conditions for the request.

Constructor Summary

Constructors
Constructor and Description

ListBlobRegionsOptions()

Constructors
Constructor and Description
`ListBlobRegionsOptions()`

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 `ListBlobRegionsOptions` instance.
`String`	`getLeaseId()` Gets the lease ID to match for the blob set in this `ListBlobRegionsOptions` instance.
`Long`	`getRangeEnd()` Gets the ending byte offset value for the valid page ranges to return set in this `ListBlobRegionsOptions` instance.
`Long`	`getRangeStart()` Gets the beginning byte offset value of the valid page ranges to return set in this `ListBlobRegionsOptions` instance.
`String`	`getSnapshot()` Gets the snapshot timestamp value set in this `ListBlobRegionsOptions` instance.
`ListBlobRegionsOptions`	`setAccessCondition(com.microsoft.windowsazure.core.utils.AccessConditionHeader accessCondition)` Sets optional access conditions for getting the valid page ranges of the blob.
`ListBlobRegionsOptions`	`setLeaseId(String leaseId)` Sets an optional lease ID value to match when getting the valid page ranges of the blob.
`ListBlobRegionsOptions`	`setRangeEnd(Long rangeEnd)` Sets an optional ending byte offset value of the valid page ranges to return for the request, inclusive.
`ListBlobRegionsOptions`	`setRangeStart(Long rangeStart)` Sets an optional beginning byte offset value of the valid page ranges to return for the request, inclusive.
`ListBlobRegionsOptions`	`setSnapshot(String snapshot)` Sets an optional snapshot timestamp value used to identify the particular snapshot of the blob to get valid page ranges for.
`ListBlobRegionsOptions`	`setTimeout(Integer timeout)` Sets the optional server request timeout value associated with this `ListBlobRegionsOptions` 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
  - ListBlobRegionsOptions
```
public ListBlobRegionsOptions()
```
- Method Detail
  - setTimeout
```
public ListBlobRegionsOptions setTimeout(Integer timeout)
```
    Sets the optional server request timeout value associated with this ListBlobRegionsOptions instance.
    The timeout value only affects calls made on methods where this ListBlobRegionsOptions 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 ListBlobRegionsOptions instance.
  - getLeaseId
```
public String getLeaseId()
```
    Gets the lease ID to match for the blob set in this ListBlobRegionsOptions instance.
    
    Returns:
    
    A String containing the lease ID set, if any.
  - setLeaseId
```
public ListBlobRegionsOptions setLeaseId(String leaseId)
```
    Sets an optional lease ID value to match when getting the valid page ranges 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 ListBlobRegionsOptions instance is passed as a parameter.
    
    Parameters:
    
    leaseId - A String containing the lease ID to set.
    
    Returns:
    
    A reference to this ListBlobRegionsOptions instance.
  - getSnapshot
```
public String getSnapshot()
```
    Gets the snapshot timestamp value set in this ListBlobRegionsOptions instance.
    
    Returns:
    
    A String containing the snapshot timestamp value of the blob snapshot to get valid page ranges for.
  - setSnapshot
```
public ListBlobRegionsOptions setSnapshot(String snapshot)
```
    Sets an optional snapshot timestamp value used to identify the particular snapshot of the blob to get valid page ranges for. The snapshot timestamp value is an opaque value returned by the server to identify a snapshot. When this option is set, only the valid page ranges of the snapshot are returned.
    Note that this value only affects calls made on methods where this ListBlobRegionsOptions instance is passed as a parameter.
    
    Parameters:
    
    snapshot - A String containing the snapshot timestamp value of the blob snapshot to get valid page ranges for.
    
    Returns:
    
    A reference to this ListBlobRegionsOptions instance.
  - getRangeStart
```
public Long getRangeStart()
```
    Gets the beginning byte offset value of the valid page ranges to return set in this ListBlobRegionsOptions instance.
    
    Returns:
    
    The beginning offset value in bytes for the valid page ranges to return.
  - setRangeStart
```
public ListBlobRegionsOptions setRangeStart(Long rangeStart)
```
    Sets an optional beginning byte offset value of the valid page ranges to return for the request, inclusive.
    If the range end is not set, the response includes valid page ranges from the rangeStart value to the end of the blob.
    Note that this value only affects calls made on methods where this ListBlobRegionsOptions instance is passed as a parameter.
    
    Parameters:
    
    rangeStart - The beginning offset value in bytes for the valid page ranges to return, inclusive.
    
    Returns:
    
    A reference to this ListBlobRegionsOptions instance.
  - getRangeEnd
```
public Long getRangeEnd()
```
    Gets the ending byte offset value for the valid page ranges to return set in this ListBlobRegionsOptions instance.
    
    Returns:
    
    The ending offset value in bytes for the valid page ranges to return.
  - setRangeEnd
```
public ListBlobRegionsOptions setRangeEnd(Long rangeEnd)
```
    Sets an optional ending byte offset value of the valid page ranges to return for the request, inclusive.
    If the range start is not set, this value is ignored and the response includes valid page ranges from the entire blob.
    Note that this value only affects calls made on methods where this ListBlobRegionsOptions instance is passed as a parameter.
    
    Parameters:
    
    rangeEnd - The ending offset value in bytes for the valid page ranges to return, inclusive.
    
    Returns:
    
    A reference to this ListBlobRegionsOptions instance.
  - getAccessCondition
```
public com.microsoft.windowsazure.core.utils.AccessConditionHeader getAccessCondition()
```
    Gets the access conditions set in this ListBlobRegionsOptions instance.
    
    Returns:
    
    An AccessCondition containing the access conditions set, if any.
  - setAccessCondition
```
public ListBlobRegionsOptions setAccessCondition(com.microsoft.windowsazure.core.utils.AccessConditionHeader accessCondition)
```
    Sets optional access conditions for getting the valid page ranges of 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 ListBlobRegionsOptions instance is passed as a parameter.
    
    Parameters:
    
    accessCondition - An AccessCondition containing the access conditions to set.
    
    Returns:
    
    A reference to this ListBlobRegionsOptions 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 ListBlobRegionsOptions

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

ListBlobRegionsOptions

Method Detail

setTimeout

getLeaseId

setLeaseId

getSnapshot

setSnapshot

getRangeStart

setRangeStart

getRangeEnd

setRangeEnd

getAccessCondition

setAccessCondition