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

```
public class CopyBlobOptions
extends BlobServiceOptions
```
Represents the options that may be set on a copyBlob request. These options include an optional server timeout for the operation, an optional source snapshot timestamp value to copy from a particular snapshot of the source blob, blob metadata to set on the destination blob, a blob lease ID to overwrite a blob with an active lease, a source lease ID to copy from a source blob with an active lease, any access conditions to satisfy on the destination, and any access conditions to satisfy on the source.

Constructor Summary

Constructors
Constructor and Description

CopyBlobOptions()

Constructors
Constructor and Description
`CopyBlobOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CopyBlobOptions`	`addMetadata(String key, String value)` Adds a name-value pair to the blob metadata collection associated with this `CopyBlobOptions` instance.
`com.microsoft.windowsazure.core.utils.AccessConditionHeader`	`getAccessCondition()` Gets the access conditions on the destination blob set in this `CopyBlobOptions` instance.
`String`	`getLeaseId()` Gets the lease ID to match for the destination blob set in this `CopyBlobOptions` instance.
`HashMap<String,String>`	`getMetadata()` Gets the blob metadata collection set in this `CopyBlobOptions` instance.
`com.microsoft.windowsazure.core.utils.AccessConditionHeader`	`getSourceAccessCondition()` Gets the access conditions on the source blob set in this `CopyBlobOptions` instance.
`String`	`getSourceLeaseId()` Gets the lease ID to match for the source blob set in this `CopyBlobOptions` instance.
`String`	`getSourceSnapshot()` Gets the source snapshot timestamp value set in this `CopyBlobOptions` instance.
`CopyBlobOptions`	`setAccessCondition(com.microsoft.windowsazure.core.utils.AccessConditionHeader accessCondition)` Sets optional access conditions for the destination blob.
`CopyBlobOptions`	`setLeaseId(String leaseId)` Sets a lease ID value to match on the destination blob.
`CopyBlobOptions`	`setMetadata(HashMap<String,String> metadata)` Sets the blob metadata collection to associate with the destination blob.
`CopyBlobOptions`	`setSourceAccessCondition(com.microsoft.windowsazure.core.utils.AccessConditionHeader sourceAccessCondition)` Sets optional access conditions for the source blob.
`CopyBlobOptions`	`setSourceLeaseId(String sourceLeaseId)` Sets a lease ID value to match on the source blob.
`CopyBlobOptions`	`setSourceSnapshot(String sourceSnapshot)` Sets the snapshot timestamp value used to identify the particular snapshot of the source blob to copy.
`CopyBlobOptions`	`setTimeout(Integer timeout)` Sets the optional server request timeout value associated with this `CopyBlobOptions` 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
  - CopyBlobOptions
```
public CopyBlobOptions()
```
- Method Detail
  - setTimeout
```
public CopyBlobOptions setTimeout(Integer timeout)
```
    Sets the optional server request timeout value associated with this CopyBlobOptions instance.
    The timeout value only affects calls made on methods where this CopyBlobOptions 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 CopyBlobOptions instance.
  - getSourceSnapshot
```
public String getSourceSnapshot()
```
    Gets the source snapshot timestamp value set in this CopyBlobOptions instance.
    
    Returns:
    
    A String containing the snapshot timestamp value of the source blob snapshot to list.
  - setSourceSnapshot
```
public CopyBlobOptions setSourceSnapshot(String sourceSnapshot)
```
    Sets the snapshot timestamp value used to identify the particular snapshot of the source blob to copy. The snapshot timestamp value is an opaque value returned by the server to identify a snapshot. When this option is set, the properties, metadata, and content of the snapshot are copied to the destination.
    Note that this value only affects calls made on methods where this ListBlobBlocksOptions instance is passed as a parameter.
    
    Parameters:
    
    sourceSnapshot - A String containing the snapshot timestamp value of the source blob snapshot to list.
    
    Returns:
    
    A reference to this ListBlobBlocksOptions instance.
  - getMetadata
```
public HashMap<String,String> getMetadata()
```
    Gets the blob metadata collection set in this CopyBlobOptions instance.
    
    Returns:
    
    A HashMap of name-value pairs of String containing the blob metadata set, if any.
  - setMetadata
```
public CopyBlobOptions setMetadata(HashMap<String,String> metadata)
```
    Sets the blob metadata collection to associate with the destination 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.
    Note that if any metadata is set with this option, no source blob metadata will be copied to the destination blob.
    The metadata value only affects calls made on methods where this CreateBlobOptions 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 CreateBlobOptions instance.
  - addMetadata
```
public CopyBlobOptions addMetadata(String key,
                                   String value)
```
    Adds a name-value pair to the blob metadata collection associated with this CopyBlobOptions instance.
    Note that if any metadata is set with this option, no source blob metadata will be copied to the destination blob.
    
    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 CopyBlobOptions instance.
  - getLeaseId
```
public String getLeaseId()
```
    Gets the lease ID to match for the destination blob set in this CopyBlobOptions instance.
    
    Returns:
    
    A String containing the lease ID set, if any.
  - setLeaseId
```
public CopyBlobOptions setLeaseId(String leaseId)
```
    Sets a lease ID value to match on the destination blob. If set, there must be an active lease with a matching lease ID set on the destination blob for the operation to succeed.
    Note that this value only affects calls made on methods where this CopyBlobOptions instance is passed as a parameter.
    
    Parameters:
    
    leaseId - A String containing the lease ID to set.
    
    Returns:
    
    A reference to this CopyBlobOptions instance.
  - getSourceLeaseId
```
public String getSourceLeaseId()
```
    Gets the lease ID to match for the source blob set in this CopyBlobOptions instance.
    
    Returns:
    
    A String containing the source blob lease ID set, if any.
  - setSourceLeaseId
```
public CopyBlobOptions setSourceLeaseId(String sourceLeaseId)
```
    Sets a lease ID value to match on the source blob. If set, there must be an active lease with a matching lease ID set on the source blob for the operation to succeed.
    Note that this value only affects calls made on methods where this CopyBlobOptions instance is passed as a parameter.
    
    Parameters:
    
    sourceLeaseId - A String containing the source blob lease ID to set.
    
    Returns:
    
    A reference to this CopyBlobOptions instance.
  - getAccessCondition
```
public com.microsoft.windowsazure.core.utils.AccessConditionHeader getAccessCondition()
```
    Gets the access conditions on the destination blob set in this CopyBlobOptions instance.
    
    Returns:
    
    An AccessCondition containing the destination blob access conditions set, if any.
  - setAccessCondition
```
public CopyBlobOptions setAccessCondition(com.microsoft.windowsazure.core.utils.AccessConditionHeader accessCondition)
```
    Sets optional access conditions for the destination 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 CopyBlobOptions instance is passed as a parameter.
    
    Parameters:
    
    accessCondition - An AccessCondition containing the destination blob access conditions to set.
    
    Returns:
    
    A reference to this CopyBlobOptions instance.
  - getSourceAccessCondition
```
public com.microsoft.windowsazure.core.utils.AccessConditionHeader getSourceAccessCondition()
```
    Gets the access conditions on the source blob set in this CopyBlobOptions instance.
    
    Returns:
    
    An AccessCondition containing the source blob access conditions set, if any.
  - setSourceAccessCondition
```
public CopyBlobOptions setSourceAccessCondition(com.microsoft.windowsazure.core.utils.AccessConditionHeader sourceAccessCondition)
```
    Sets optional access conditions for the source 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 CopyBlobOptions instance is passed as a parameter.
    
    Parameters:
    
    sourceAccessCondition - An AccessCondition containing the source blob access conditions to set.
    
    Returns:
    
    A reference to this CopyBlobOptions 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 CopyBlobOptions

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

CopyBlobOptions

Method Detail

setTimeout

getSourceSnapshot

setSourceSnapshot

getMetadata

setMetadata

addMetadata

getLeaseId

setLeaseId

getSourceLeaseId

setSourceLeaseId

getAccessCondition

setAccessCondition

getSourceAccessCondition

setSourceAccessCondition