Interface IIngestClient

Namespace: System.Dynamic.ExpandoObject

Syntax

[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public interface IIngestClient

Methods

CreateIngestContainerAsync(CancellationToken)

Create ingest container.

Declaration

Task<IngestContainerCreateResult> CreateIngestContainerAsync(CancellationToken cancellationToken = default)

Parameters

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<IngestContainerCreateResult> Ingest container create result containing container name and SAS token for uploading data.

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

ImportAllAsync(string, ImportAllFromContainerRequest, CancellationToken)

Import all files from the specified container.

Declaration

Task<BusinessProcess> ImportAllAsync(string containerName, ImportAllFromContainerRequest request, CancellationToken cancellationToken = default)

Parameters

string containerName Container name

ImportAllFromContainerRequest request Import request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<BusinessProcess> BusinessProcess

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

ImportFromUrlsAsync(ImportFromUrlsRequest, CancellationToken)

Import specified urls.

Declaration

Task<BusinessProcess> ImportFromUrlsAsync(ImportFromUrlsRequest request, CancellationToken cancellationToken = default)

Parameters

ImportFromUrlsRequest request Import request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<BusinessProcess> BusinessProcess

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

ImportPartialAsync(string, ImportPartialFromContainerRequest, CancellationToken)

Import specified files from the specified container.

Declaration

Task<BusinessProcess> ImportPartialAsync(string containerName, ImportPartialFromContainerRequest request, CancellationToken cancellationToken = default)

Parameters

string containerName Container name

ImportPartialFromContainerRequest request Import request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<BusinessProcess> BusinessProcess

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

Extension Methods

IngestClientExtensions.ImportFilesAsync(IIngestClient, IDictionary<IngestFile, FileImportWithFileNameOverrideRequest>, ImportOptions?, TimeSpan?, bool, CancellationToken)

IngestClientExtensions.ImportFilesAsync(IIngestClient, IReadOnlyCollection<IngestFile>, ImportOptions?, FileImportRequest?, TimeSpan?, bool, CancellationToken)

IngestClientExtensions.ImportFromUrlsAsync(IIngestClient, IDictionary<string, UrlImportRequest>, ImportOptions?, TimeSpan?, bool, CancellationToken)

IngestClientExtensions.UploadAndImportFilesAsync(IIngestClient, IEnumerable<IngestUploadItem>, FileImportRequest?, IngestUploadOptions?, ImportOptions?, TimeSpan?, bool, CancellationToken)

IngestClientExtensions.UploadAndImportFilesAsync(IIngestClient, IEnumerable<string>, FileImportRequest?, IngestUploadOptions?, ImportOptions?, TimeSpan?, bool, CancellationToken)

IngestClientExtensions.UploadFileAsync(IIngestClient, IngestUploadItem, CancellationToken)

IngestClientExtensions.UploadFileAsync(IIngestClient, string, CancellationToken)

IngestClientExtensions.UploadFilesAsync(IIngestClient, IEnumerable<IngestUploadItem>, IngestUploadOptions?, CancellationToken)

IngestClientExtensions.UploadFilesAsync(IIngestClient, IEnumerable<string>, IngestUploadOptions?, CancellationToken)