IngestionClient Class

Definition

Namespace:
Azure.Analytics.PlanetaryComputer
Assembly:
Azure.Analytics.PlanetaryComputer.dll
Package:
Azure.Analytics.PlanetaryComputer v1.0.0
Source:
IngestionClient.cs

The IngestionClient sub-client.

public class IngestionClient
type IngestionClient = class
Public Class IngestionClient
Inheritance
Object
IngestionClient

Constructors

Name Description
IngestionClient()

Initializes a new instance of IngestionClient for mocking.

Properties

Name Description
Pipeline

The HTTP pipeline for sending and receiving REST requests and responses.

Methods

Name Description
CancelAllOperations(CancellationToken)

Cancel all pending and running operations across the entire GeoCatalog instance. This is a catalog-wide operation and is not scoped to a specific collection.
CancelAllOperations(RequestContext)

[Protocol Method] Cancel all pending and running operations across the entire GeoCatalog instance. This is a catalog-wide operation and is not scoped to a specific collection.

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

Cancel all pending and running operations across the entire GeoCatalog instance. This is a catalog-wide operation and is not scoped to a specific collection.
CancelAllOperationsAsync(RequestContext)

[Protocol Method] Cancel all pending and running operations across the entire GeoCatalog instance. This is a catalog-wide operation and is not scoped to a specific collection.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CancelOperation(Guid, CancellationToken)

Cancel a running operation of a geo-catalog collection.
CancelOperation(Guid, RequestContext)

[Protocol Method] Cancel a running operation of a geo-catalog collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CancelOperationAsync(Guid, CancellationToken)

Cancel a running operation of a geo-catalog collection.
CancelOperationAsync(Guid, RequestContext)

[Protocol Method] Cancel a running operation of a geo-catalog collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
Create(String, IngestionInformation, CancellationToken)

Create a new ingestion.
Create(String, RequestContent, RequestContext)

[Protocol Method] Create a new ingestion

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateAsync(String, IngestionInformation, CancellationToken)

Create a new ingestion.
CreateAsync(String, RequestContent, RequestContext)

[Protocol Method] Create a new ingestion

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateRun(String, Guid, CancellationToken)

Create a new run of an ingestion.
CreateRun(String, Guid, RequestContext)

[Protocol Method] Create a new run of an ingestion

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateRunAsync(String, Guid, CancellationToken)

Create a new run of an ingestion.
CreateRunAsync(String, Guid, RequestContext)

[Protocol Method] Create a new run of an ingestion

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateSource(IngestionSource, CancellationToken)

Create a new ingestion source in a geo-catalog.
CreateSource(RequestContent, RequestContext)

[Protocol Method] Create a new ingestion source in a geo-catalog

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateSourceAsync(IngestionSource, CancellationToken)

Create a new ingestion source in a geo-catalog.
CreateSourceAsync(RequestContent, RequestContext)

[Protocol Method] Create a new ingestion source in a geo-catalog

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
Delete(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.
Delete(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)

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

Delete an ingestion source from a geo-catalog.
DeleteSource(Guid, RequestContext)

[Protocol Method] Delete an ingestion source from a geo-catalog

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteSourceAsync(Guid, CancellationToken)

Delete an ingestion source from a geo-catalog.
DeleteSourceAsync(Guid, RequestContext)

[Protocol Method] Delete an ingestion source from a geo-catalog

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
Get(String, Guid, CancellationToken)

Get the definition of an ingestion.
Get(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.
GetAll(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Get ingestions of a catalog.
GetAll(String, Nullable<Int32>, Nullable<Int32>, RequestContext)

[Protocol Method] Get ingestions of a catalog

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetAllAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Get ingestions of a catalog.
GetAllAsync(String, Nullable<Int32>, Nullable<Int32>, RequestContext)

[Protocol Method] Get ingestions of a catalog

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
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.
GetManagedIdentities(CancellationToken)

Get all managed identities with access to storage accounts configured for a geo-catalog.
GetManagedIdentities(RequestContext)

[Protocol Method] Get all managed identities with access to storage accounts configured for a geo-catalog

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

Get all managed identities with access to storage accounts configured for a geo-catalog.
GetManagedIdentitiesAsync(RequestContext)

[Protocol Method] Get all managed identities with access to storage accounts configured for a geo-catalog

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetOperation(Guid, CancellationToken)

Get an operation of a geo-catalog collection.
GetOperation(Guid, RequestContext)

[Protocol Method] Get an operation of a geo-catalog collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetOperationAsync(Guid, CancellationToken)

Get an operation of a geo-catalog collection.
GetOperationAsync(Guid, RequestContext)

[Protocol Method] Get an operation of a geo-catalog collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetOperations(Nullable<Int32>, Nullable<Int32>, String, Nullable<PlanetaryComputerOperationStatus>, CancellationToken)

Get operations of a geo-catalog collection.
GetOperations(Nullable<Int32>, Nullable<Int32>, String, String, RequestContext)

[Protocol Method] Get operations of a geo-catalog collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetOperationsAsync(Nullable<Int32>, Nullable<Int32>, String, Nullable<PlanetaryComputerOperationStatus>, CancellationToken)

Get operations of a geo-catalog collection.
GetOperationsAsync(Nullable<Int32>, Nullable<Int32>, String, String, RequestContext)

[Protocol Method] Get operations of a geo-catalog collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetRun(String, Guid, Guid, CancellationToken)

Get a run of an ingestion.
GetRun(String, Guid, Guid, RequestContext)

[Protocol Method] Get a run of an ingestion

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetRunAsync(String, Guid, Guid, CancellationToken)

Get a run of an ingestion.
GetRunAsync(String, Guid, Guid, RequestContext)

[Protocol Method] Get a run of an ingestion

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetRuns(String, Guid, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Get the runs of an ingestion.
GetRuns(String, Guid, Nullable<Int32>, Nullable<Int32>, RequestContext)

[Protocol Method] Get the runs of an ingestion

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetRunsAsync(String, Guid, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Get the runs of an ingestion.
GetRunsAsync(String, Guid, Nullable<Int32>, Nullable<Int32>, RequestContext)

[Protocol Method] Get the runs of an ingestion

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetSource(Guid, CancellationToken)

Get an ingestion source in a geo-catalog.
GetSource(Guid, RequestContext)

[Protocol Method] Get an ingestion source in a geo-catalog

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetSourceAsync(Guid, CancellationToken)

Get an ingestion source in a geo-catalog.
GetSourceAsync(Guid, RequestContext)

[Protocol Method] Get an ingestion source in a geo-catalog

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetSources(Nullable<Int32>, Nullable<Int32>, CancellationToken)

Get ingestion sources in a geo-catalog.
GetSources(Nullable<Int32>, Nullable<Int32>, RequestContext)

[Protocol Method] Get ingestion sources in a geo-catalog

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetSourcesAsync(Nullable<Int32>, Nullable<Int32>, CancellationToken)

Get ingestion sources in a geo-catalog.
GetSourcesAsync(Nullable<Int32>, Nullable<Int32>, RequestContext)

[Protocol Method] Get ingestion sources in a geo-catalog

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ReplaceSource(Guid, IngestionSource, CancellationToken)

Update an existing ingestion source in a geo-catalog.
ReplaceSource(Guid, RequestContent, RequestContext)

[Protocol Method] Update an existing ingestion source in a geo-catalog

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ReplaceSourceAsync(Guid, IngestionSource, CancellationToken)

Update an existing ingestion source in a geo-catalog.
ReplaceSourceAsync(Guid, RequestContent, RequestContext)

[Protocol Method] Update an existing ingestion source in a geo-catalog

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
Update(String, Guid, RequestContent, RequestContext)

[Protocol Method] Update an existing ingestion

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
UpdateAsync(String, Guid, RequestContent, RequestContext)

[Protocol Method] Update an existing ingestion

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

Applies to