IngestionClient.GetAsync Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Overloads

Name	Description
GetAsync(String, Guid, CancellationToken)	Get the definition of an ingestion.
GetAsync(String, Guid, RequestContext)	[Protocol Method] Get the definition of an ingestion This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

GetAsync(String, Guid, CancellationToken)

Source:

IngestionClient.cs

Get the definition of an ingestion.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.PlanetaryComputer.IngestionInformation>> GetAsync(string collectionId, Guid ingestionId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetAsync : string * Guid * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.PlanetaryComputer.IngestionInformation>>
override this.GetAsync : string * Guid * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.PlanetaryComputer.IngestionInformation>>

Public Overridable Function GetAsync (collectionId As String, ingestionId As Guid, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IngestionInformation))

Parameters

collectionId

String

Catalog collection id.

ingestionId

Guid

Ingestion id.

cancellationToken

CancellationToken

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

Returns

Task<Response<IngestionInformation>>

Exceptions

ArgumentNullException

collectionId is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

GetAsync(String, Guid, RequestContext)

Source:

IngestionClient.cs

[Protocol Method] Get the definition of an ingestion

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

public virtual System.Threading.Tasks.Task<Azure.Response> GetAsync(string collectionId, Guid ingestionId, Azure.RequestContext context);

abstract member GetAsync : string * Guid * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetAsync : string * Guid * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetAsync (collectionId As String, ingestionId As Guid, context As RequestContext) As Task(Of Response)

Parameters

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<Response>

The response returned from the service.

Exceptions

ArgumentNullException

collectionId is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.