IngestionClient.DeleteAsync Method

Definition

Namespace:: Azure.Analytics.PlanetaryComputer

Assembly:: Azure.Analytics.PlanetaryComputer.dll

Package:: Azure.Analytics.PlanetaryComputer v1.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

Name	Description
DeleteAsync(WaitUntil, String, Guid, RequestContext)	Delete an ingestion from a catalog. All runs of the ingestion will be deleted. Ingestion must not have any runs in progress or queued.
DeleteAsync(WaitUntil, String, Guid, CancellationToken)	Delete an ingestion from a catalog. All runs of the ingestion will be deleted. Ingestion must not have any runs in progress or queued.

DeleteAsync(WaitUntil, String, Guid, RequestContext)

Source:: IngestionClient.cs

Delete an ingestion from a catalog. All runs of the ingestion will be deleted. Ingestion must not have any runs in progress or queued.

public virtual System.Threading.Tasks.Task<Azure.Operation> DeleteAsync(Azure.WaitUntil waitUntil, string collectionId, Guid ingestionId, Azure.RequestContext context);

abstract member DeleteAsync : Azure.WaitUntil * string * Guid * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>
override this.DeleteAsync : Azure.WaitUntil * string * Guid * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>

Public Overridable Function DeleteAsync (waitUntil As WaitUntil, collectionId As String, ingestionId As Guid, context As RequestContext) As Task(Of Operation)

Parameters

waitUntil: WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

collectionId: String

Catalog collection id.

ingestionId: Guid

Ingestion id.

context: RequestContext

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

Returns

Task<Operation>

The response returned from the service.

Exceptions

ArgumentNullException

collectionId is null.

ArgumentException

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

Applies to

DeleteAsync(WaitUntil, String, Guid, CancellationToken)

Source:: IngestionClient.cs

Delete an ingestion from a catalog. All runs of the ingestion will be deleted. Ingestion must not have any runs in progress or queued.

public virtual System.Threading.Tasks.Task<Azure.Operation> DeleteAsync(Azure.WaitUntil waitUntil, string collectionId, Guid ingestionId, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteAsync : Azure.WaitUntil * string * Guid * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation>
override this.DeleteAsync : Azure.WaitUntil * string * Guid * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation>

Public Overridable Function DeleteAsync (waitUntil As WaitUntil, collectionId As String, ingestionId As Guid, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Operation)