IngestionOperations interface

Package:

@azure/planetarycomputer

Interface representing a Ingestion operations.

Properties

cancelAllOperations	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.
cancelOperation	Cancel a running operation of a geo-catalog collection
create	Create a new ingestion
createRun	Create a new run of an ingestion
createSource	Create a new ingestion source in a geo-catalog
deleteIngestion	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	Delete an ingestion source from a geo-catalog
get	Get the definition of an ingestion
getOperation	Get an operation of a geo-catalog collection
getRun	Get a run of an ingestion
getSource	Get an ingestion source in a geo-catalog
list	Get ingestions of a catalog
listManagedIdentities	Get all managed identities with access to storage accounts configured for a geo-catalog
listOperations	Get operations of a geo-catalog collection
listRuns	Get the runs of an ingestion
listSources	Get ingestion sources in a geo-catalog
replaceSource	Update an existing ingestion source in a geo-catalog
update	Update an existing ingestion

Property Details

cancelAllOperations

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: (options?: IngestionCancelAllOperationsOptionalParams) => Promise<void>

Property Value

(options?: IngestionCancelAllOperationsOptionalParams) => Promise<void>

cancelOperation

Cancel a running operation of a geo-catalog collection

cancelOperation: (operationId: string, options?: IngestionCancelOperationOptionalParams) => Promise<void>

Property Value

(operationId: string, options?: IngestionCancelOperationOptionalParams) => Promise<void>

create

Create a new ingestion

create: (collectionId: string, body: IngestionDefinition, options?: IngestionCreateOptionalParams) => Promise<IngestionDefinition>

Property Value

(collectionId: string, body: IngestionDefinition, options?: IngestionCreateOptionalParams) => Promise<IngestionDefinition>

createRun

Create a new run of an ingestion

createRun: (collectionId: string, ingestionId: string, options?: IngestionCreateRunOptionalParams) => Promise<IngestionRun>

Property Value

(collectionId: string, ingestionId: string, options?: IngestionCreateRunOptionalParams) => Promise<IngestionRun>

createSource

Create a new ingestion source in a geo-catalog

createSource: (body: IngestionSourceUnion, options?: IngestionCreateSourceOptionalParams) => Promise<IngestionSourceUnion>

Property Value

(body: IngestionSourceUnion, options?: IngestionCreateSourceOptionalParams) => Promise<IngestionSourceUnion>

deleteIngestion

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

deleteIngestion: (collectionId: string, ingestionId: string, options?: IngestionDeleteIngestionOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(collectionId: string, ingestionId: string, options?: IngestionDeleteIngestionOptionalParams) => PollerLike<OperationState<void>, void>

deleteSource

Delete an ingestion source from a geo-catalog

deleteSource: (id: string, options?: IngestionDeleteSourceOptionalParams) => Promise<void>

Property Value

(id: string, options?: IngestionDeleteSourceOptionalParams) => Promise<void>

get

Get the definition of an ingestion

get: (collectionId: string, ingestionId: string, options?: IngestionGetOptionalParams) => Promise<IngestionDefinition>

Property Value

(collectionId: string, ingestionId: string, options?: IngestionGetOptionalParams) => Promise<IngestionDefinition>

getOperation

Get an operation of a geo-catalog collection

getOperation: (operationId: string, options?: IngestionGetOperationOptionalParams) => Promise<Operation>

Property Value

(operationId: string, options?: IngestionGetOperationOptionalParams) => Promise<Operation>

getRun

Get a run of an ingestion

getRun: (collectionId: string, ingestionId: string, runId: string, options?: IngestionGetRunOptionalParams) => Promise<IngestionRun>

Property Value

(collectionId: string, ingestionId: string, runId: string, options?: IngestionGetRunOptionalParams) => Promise<IngestionRun>

getSource

Get an ingestion source in a geo-catalog

getSource: (id: string, options?: IngestionGetSourceOptionalParams) => Promise<IngestionSourceUnion>

Property Value

(id: string, options?: IngestionGetSourceOptionalParams) => Promise<IngestionSourceUnion>

list

Get ingestions of a catalog

list: (collectionId: string, options?: IngestionListOptionalParams) => PagedAsyncIterableIterator<IngestionDefinition, IngestionDefinition[], PageSettings>

Property Value

(collectionId: string, options?: IngestionListOptionalParams) => PagedAsyncIterableIterator<IngestionDefinition, IngestionDefinition[], PageSettings>

listManagedIdentities

Get all managed identities with access to storage accounts configured for a geo-catalog

listManagedIdentities: (options?: IngestionListManagedIdentitiesOptionalParams) => PagedAsyncIterableIterator<ManagedIdentityMetadata, ManagedIdentityMetadata[], PageSettings>

Property Value

(options?: IngestionListManagedIdentitiesOptionalParams) => PagedAsyncIterableIterator<ManagedIdentityMetadata, ManagedIdentityMetadata[], PageSettings>

listOperations

Get operations of a geo-catalog collection

listOperations: (options?: IngestionListOperationsOptionalParams) => PagedAsyncIterableIterator<Operation, Operation[], PageSettings>

Property Value

(options?: IngestionListOperationsOptionalParams) => PagedAsyncIterableIterator<Operation, Operation[], PageSettings>

listRuns

Get the runs of an ingestion

listRuns: (collectionId: string, ingestionId: string, options?: IngestionListRunsOptionalParams) => PagedAsyncIterableIterator<IngestionRun, IngestionRun[], PageSettings>

Property Value

(collectionId: string, ingestionId: string, options?: IngestionListRunsOptionalParams) => PagedAsyncIterableIterator<IngestionRun, IngestionRun[], PageSettings>

listSources

Get ingestion sources in a geo-catalog

listSources: (options?: IngestionListSourcesOptionalParams) => PagedAsyncIterableIterator<IngestionSourceSummary, IngestionSourceSummary[], PageSettings>

Property Value

(options?: IngestionListSourcesOptionalParams) => PagedAsyncIterableIterator<IngestionSourceSummary, IngestionSourceSummary[], PageSettings>

replaceSource

Update an existing ingestion source in a geo-catalog

replaceSource: (id: string, body: IngestionSourceUnion, options?: IngestionReplaceSourceOptionalParams) => Promise<IngestionSourceUnion>

Property Value

(id: string, body: IngestionSourceUnion, options?: IngestionReplaceSourceOptionalParams) => Promise<IngestionSourceUnion>

update

Update an existing ingestion

update: (collectionId: string, ingestionId: string, body: IngestionDefinition, options?: IngestionUpdateOptionalParams) => Promise<IngestionDefinition>

Property Value

(collectionId: string, ingestionId: string, body: IngestionDefinition, options?: IngestionUpdateOptionalParams) => Promise<IngestionDefinition>