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

```
public class CreateBlobSnapshotOptions
extends BlobServiceOptions
```
Represents the options that may be set on a createBlobSnapshot request. These options include an optional server timeout for the operation, blob metadata to set on the 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

CreateBlobSnapshotOptions()

Constructors
Constructor and Description
`CreateBlobSnapshotOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateBlobSnapshotOptions`	`addMetadata(String key, String value)` Adds a name-value pair to the metadata collection associated with this `CreateBlobSnapshotOptions` instance.
`com.microsoft.windowsazure.core.utils.AccessConditionHeader`	`getAccessCondition()` Gets the access conditions set in this `CreateBlobSnapshotOptions` instance.
`String`	`getLeaseId()` Gets the lease ID to match for the blob set in this `CreateBlobSnapshotOptions` instance.
`HashMap<String,String>`	`getMetadata()` Gets the metadata collection set in this `CreateBlobSnapshotOptions` instance.
`CreateBlobSnapshotOptions`	`setAccessCondition(com.microsoft.windowsazure.core.utils.AccessConditionHeader accessCondition)` Sets optional access conditions for creating a snapshot of the blob.
`CreateBlobSnapshotOptions`	`setLeaseId(String leaseId)` Sets an optional lease ID value to match when creating a snapshot of the blob.
`CreateBlobSnapshotOptions`	`setMetadata(HashMap<String,String> metadata)` Sets the metadata collection to associate with a snapshot.
`CreateBlobSnapshotOptions`	`setTimeout(Integer timeout)` Sets the optional server request timeout value associated with this `CreateBlobSnapshotOptions` 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
  - CreateBlobSnapshotOptions
```
public CreateBlobSnapshotOptions()
```
- Method Detail
  - setTimeout
```
public CreateBlobSnapshotOptions setTimeout(Integer timeout)
```
    Sets the optional server request timeout value associated with this CreateBlobSnapshotOptions instance.
    The timeout value only affects calls made on methods where this CreateBlobSnapshotOptions 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 CreateBlobSnapshotOptions instance.
  - getMetadata
```
public HashMap<String,String> getMetadata()
```
    Gets the metadata collection set in this CreateBlobSnapshotOptions instance.
    
    Returns:
    
    A HashMap of name-value pairs of String containing the blob metadata set, if any.
  - setMetadata
```
public CreateBlobSnapshotOptions setMetadata(HashMap<String,String> metadata)
```
    Sets the metadata collection to associate with a snapshot. 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 CreateBlobSnapshotOptions instance is passed as a parameter.
    
    Parameters:
    
    metadata - A HashMap of name-value pairs of String containing the names and values of the metadata to set.
    
    Returns:
    
    A reference to this CreateBlobSnapshotOptions instance.
  - addMetadata
```
public CreateBlobSnapshotOptions addMetadata(String key,
                                             String value)
```
    Adds a name-value pair to the metadata collection associated with this CreateBlobSnapshotOptions 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 CreateBlobSnapshotOptions instance.
  - getLeaseId
```
public String getLeaseId()
```
    Gets the lease ID to match for the blob set in this CreateBlobSnapshotOptions instance.
    
    Returns:
    
    A String containing the lease ID set, if any.
  - setLeaseId
```
public CreateBlobSnapshotOptions setLeaseId(String leaseId)
```
    Sets an optional lease ID value to match when creating a snapshot 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 CreateBlobSnapshotOptions instance is passed as a parameter.
    
    Parameters:
    
    leaseId - A String containing the lease ID to set.
    
    Returns:
    
    A reference to this CreateBlobSnapshotOptions instance.
  - getAccessCondition
```
public com.microsoft.windowsazure.core.utils.AccessConditionHeader getAccessCondition()
```
    Gets the access conditions set in this CreateBlobSnapshotOptions instance.
    
    Returns:
    
    An AccessCondition containing the access conditions set, if any.
  - setAccessCondition
```
public CreateBlobSnapshotOptions setAccessCondition(com.microsoft.windowsazure.core.utils.AccessConditionHeader accessCondition)
```
    Sets optional access conditions for creating a snapshot 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 CreateBlobSnapshotOptions instance is passed as a parameter.
    
    Parameters:
    
    accessCondition - An AccessCondition containing the access conditions to set.
    
    Returns:
    
    A reference to this CreateBlobSnapshotOptions 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 CreateBlobSnapshotOptions

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

CreateBlobSnapshotOptions

Method Detail

setTimeout

getMetadata

setMetadata

addMetadata

getLeaseId

setLeaseId

getAccessCondition

setAccessCondition