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

```
public class DeleteBlobOptions
extends BlobServiceOptions
```
Represents the options that may be set on a deleteBlob request. These options include an optional server timeout for the operation, a snapshot timestamp to specify an individual snapshot to delete, a blob lease ID to delete a blob with an active lease, a flag indicating whether to delete all snapshots but not the blob, or both the blob and all snapshots, and any access conditions to satisfy.

Constructor Summary

Constructors
Constructor and Description

DeleteBlobOptions()

Constructors
Constructor and Description
`DeleteBlobOptions()`

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 `DeleteBlobOptions` instance.
`Boolean`	`getDeleteSnaphotsOnly()` Gets the flag indicating whether to delete only snapshots of the blob, or both the blob and all its snapshots set in this `DeleteBlobOptions` instance.
`String`	`getLeaseId()` Gets the lease ID to match for the blob set in this `DeleteBlobOptions` instance.
`String`	`getSnapshot()` Gets the snapshot timestamp value set in this `DeleteBlobOptions` instance.
`DeleteBlobOptions`	`setAccessCondition(com.microsoft.windowsazure.core.utils.AccessConditionHeader accessCondition)` Sets optional access conditions for getting the blob.
`DeleteBlobOptions`	`setDeleteSnaphotsOnly(boolean deleteSnaphotsOnly)` Sets a flag indicating whether to delete only snapshots of the blob, or both the blob and all its snapshots.
`DeleteBlobOptions`	`setLeaseId(String leaseId)` Sets an optional lease ID value to match when deleting the blob.
`DeleteBlobOptions`	`setSnapshot(String snapshot)` Reserved for future use.
`DeleteBlobOptions`	`setTimeout(Integer timeout)` Sets the optional server request timeout value associated with this `DeleteBlobOptions` 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
  - DeleteBlobOptions
```
public DeleteBlobOptions()
```
- Method Detail
  - setTimeout
```
public DeleteBlobOptions setTimeout(Integer timeout)
```
    Sets the optional server request timeout value associated with this DeleteBlobOptions instance.
    The timeout value only affects calls made on methods where this DeleteBlobOptions 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 DeleteBlobOptions instance.
  - getSnapshot
```
public String getSnapshot()
```
    Gets the snapshot timestamp value set in this DeleteBlobOptions instance.
    
    Returns:
    
    A String containing the snapshot timestamp value of the blob snapshot to get.
  - setSnapshot
```
public DeleteBlobOptions setSnapshot(String snapshot)
```
    Reserved for future use. Sets an optional snapshot timestamp value used to identify the particular snapshot of the blob to delete.
    The snapshot timestamp value is an opaque value returned by the server to identify a snapshot. This option cannot be set if the delete snapshots only option is set to true or false.
    Note that this value only affects calls made on methods where this DeleteBlobOptions 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 DeleteBlobOptions instance.
  - getLeaseId
```
public String getLeaseId()
```
    Gets the lease ID to match for the blob set in this DeleteBlobOptions instance.
    
    Returns:
    
    A String containing the lease ID set, if any.
  - setLeaseId
```
public DeleteBlobOptions setLeaseId(String leaseId)
```
    Sets an optional lease ID value to match when deleting 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 DeleteBlobOptions instance is passed as a parameter.
    
    Parameters:
    
    leaseId - A String containing the lease ID to set.
    
    Returns:
    
    A reference to this DeleteBlobOptions instance.
  - getDeleteSnaphotsOnly
```
public Boolean getDeleteSnaphotsOnly()
```
    Gets the flag indicating whether to delete only snapshots of the blob, or both the blob and all its snapshots set in this DeleteBlobOptions instance.
    
    Returns:
    
    A value of true to delete only the snapshots, or false to delete both snapshots and the blob. When the value null is set, x-ms-delete-snapshots in the header will not be set.
  - setDeleteSnaphotsOnly
```
public DeleteBlobOptions setDeleteSnaphotsOnly(boolean deleteSnaphotsOnly)
```
    Sets a flag indicating whether to delete only snapshots of the blob, or both the blob and all its snapshots.
    If the deleteSnaphotsOnly parameter is set to true, only the snapshots of the blob are deleted by the operation. If the parameter is set to false, both the blob and all its snapshots are deleted by the operation. If this option is not set on a request, and the blob has associated snapshots, the Blob service returns a 409 (Conflict) status code and a ServiceException is thrown.
    This option is not compatible with the snapshot option; if both are set the Blob service returns status code 400 (Bad Request) and a StorageException is thrown.
    Note that this value only affects calls made on methods where this DeleteBlobOptions instance is passed as a parameter.
    
    Parameters:
    
    deleteSnaphotsOnly - Set to true to delete only the snapshots, or false to delete both snapshots and the blob.
    
    Returns:
    
    A reference to this DeleteBlobOptions instance.
  - getAccessCondition
```
public com.microsoft.windowsazure.core.utils.AccessConditionHeader getAccessCondition()
```
    Gets the access conditions set in this DeleteBlobOptions instance.
    
    Returns:
    
    An AccessCondition containing the access conditions set, if any.
  - setAccessCondition
```
public DeleteBlobOptions 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 DeleteBlobOptions instance is passed as a parameter.
    
    Parameters:
    
    accessCondition - An AccessCondition containing the access conditions to set.
    
    Returns:
    
    A reference to this DeleteBlobOptions 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 DeleteBlobOptions

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

DeleteBlobOptions

Method Detail

setTimeout

getSnapshot

setSnapshot

getLeaseId

setLeaseId

getDeleteSnaphotsOnly

setDeleteSnaphotsOnly

getAccessCondition

setAccessCondition