StacClient.DeleteCollectionAsset Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Overloads

Name	Description
DeleteCollectionAsset(String, String, RequestContext)	[Protocol Method] Delete an asset from a given collection. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteCollectionAsset(String, String, CancellationToken)	Delete an asset from a given collection.

DeleteCollectionAsset(String, String, RequestContext)

Source:

StacClient.cs

[Protocol Method] Delete an asset from a given collection.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual Azure.Response DeleteCollectionAsset(string collectionId, string assetId, Azure.RequestContext context);

abstract member DeleteCollectionAsset : string * string * Azure.RequestContext -> Azure.Response
override this.DeleteCollectionAsset : string * string * Azure.RequestContext -> Azure.Response

Public Overridable Function DeleteCollectionAsset (collectionId As String, assetId As String, context As RequestContext) As Response

Parameters

collectionId

String

STAC Collection ID.

assetId

String

STAC Asset ID.

context

RequestContext

The request options, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

collectionId or assetId is null.

ArgumentException

collectionId or assetId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

DeleteCollectionAsset(String, String, CancellationToken)

Source:

StacClient.cs

Delete an asset from a given collection.

public virtual Azure.Response<Azure.Analytics.PlanetaryComputer.StacCollection> DeleteCollectionAsset(string collectionId, string assetId, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteCollectionAsset : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.PlanetaryComputer.StacCollection>
override this.DeleteCollectionAsset : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.PlanetaryComputer.StacCollection>

Public Overridable Function DeleteCollectionAsset (collectionId As String, assetId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of StacCollection)

Parameters

collectionId

String

STAC Collection ID.

assetId

String

STAC Asset ID.

cancellationToken

CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

Response<StacCollection>

Exceptions

ArgumentNullException

collectionId or assetId is null.

ArgumentException

collectionId or assetId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.