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

```
public class GetBlobMetadataOptions
extends BlobServiceOptions
```
Represents the options that may be set on a getBlobMetadata 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 properties of a snapshot, and any access conditions for the request.

Constructor Summary

Constructors
Constructor and Description

GetBlobMetadataOptions()

Constructors
Constructor and Description
`GetBlobMetadataOptions()`

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 `GetBlobMetadataOptions` instance.
`String`	`getLeaseId()` Gets the lease ID to match for the blob set in this `GetBlobMetadataOptions` instance.
`String`	`getSnapshot()` Gets the snapshot timestamp value set in this `GetBlobMetadataOptions` instance.
`GetBlobMetadataOptions`	`setAccessCondition(com.microsoft.windowsazure.core.utils.AccessConditionHeader accessCondition)` Sets the access conditions for getting the metadata of the blob.
`GetBlobMetadataOptions`	`setLeaseId(String leaseId)` Sets a lease ID value to match when getting the metadata of the blob.
`GetBlobMetadataOptions`	`setSnapshot(String snapshot)` Sets the snapshot timestamp value used to identify the particular snapshot of the blob to get metadata for.
`GetBlobMetadataOptions`	`setTimeout(Integer timeout)` Sets the optional server request timeout value associated with this `GetBlobMetadataOptions` 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
  - GetBlobMetadataOptions
```
public GetBlobMetadataOptions()
```
- Method Detail
  - setTimeout
```
public GetBlobMetadataOptions setTimeout(Integer timeout)
```
    Sets the optional server request timeout value associated with this GetBlobMetadataOptions instance.
    The timeout value only affects calls made on methods where this GetBlobMetadataOptions 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 GetBlobMetadataOptions instance.
  - getSnapshot
```
public String getSnapshot()
```
    Gets the snapshot timestamp value set in this GetBlobMetadataOptions instance.
    
    Returns:
    
    A String containing the snapshot timestamp value of the blob snapshot to get metadata for.
  - setSnapshot
```
public GetBlobMetadataOptions setSnapshot(String snapshot)
```
    Sets the snapshot timestamp value used to identify the particular snapshot of the blob to get metadata for. The snapshot timestamp value is an opaque value returned by the server to identify a snapshot. When this option is set, only the metadata of the snapshot is returned.
    Note that this value only affects calls made on methods where this GetBlobMetadataOptions instance is passed as a parameter.
    
    Parameters:
    
    snapshot - A String containing the snapshot timestamp value of the blob snapshot to get metadata for.
    
    Returns:
    
    A reference to this GetBlobMetadataOptions instance.
  - getLeaseId
```
public String getLeaseId()
```
    Gets the lease ID to match for the blob set in this GetBlobMetadataOptions instance.
    
    Returns:
    
    A String containing the lease ID set, if any.
  - setLeaseId
```
public GetBlobMetadataOptions setLeaseId(String leaseId)
```
    Sets a lease ID value to match when getting the metadata 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 GetBlobMetadataOptions instance is passed as a parameter.
    
    Parameters:
    
    leaseId - A String containing the lease ID to set.
    
    Returns:
    
    A reference to this GetBlobMetadataOptions instance.
  - getAccessCondition
```
public com.microsoft.windowsazure.core.utils.AccessConditionHeader getAccessCondition()
```
    Gets the access conditions set in this GetBlobMetadataOptions instance.
    
    Returns:
    
    An AccessCondition containing the access conditions set, if any.
  - setAccessCondition
```
public GetBlobMetadataOptions setAccessCondition(com.microsoft.windowsazure.core.utils.AccessConditionHeader accessCondition)
```
    Sets the access conditions for getting the metadata of the blob. The operation will return an error if the access conditions are not met.
    
    Parameters:
    
    accessCondition - An AccessCondition containing the access conditions to set.
    
    Returns:
    
    A reference to this GetBlobMetadataOptions 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 GetBlobMetadataOptions

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

GetBlobMetadataOptions

Method Detail

setTimeout

getSnapshot

setSnapshot

getLeaseId

setLeaseId

getAccessCondition

setAccessCondition