Class IngestClient
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class IngestClient : ClientBase, IIngestClientConstructors
IngestClient(IPictureparkServiceSettings, HttpClient)
Declaration
public IngestClient(IPictureparkServiceSettings configuration, HttpClient httpClient)Parameters
| IPictureparkServiceSettings configuration |
| HttpClient httpClient |
Properties
JsonSerializerSettings
Declaration
protected JsonSerializerSettings JsonSerializerSettings { get; }Property Value
| JsonSerializerSettings |
ReadResponseAsString
Methods
CreateIngestContainerAsync(CancellationToken)
Create ingest container.
Declaration
public virtual 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. |
Implements
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
public virtual 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 |
Implements
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
public virtual 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 |
Implements
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
public virtual 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 |
Implements
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 |
ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<string, IEnumerable<string>>, CancellationToken)
Declaration
protected virtual Task<IngestClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)Parameters
| HttpResponseMessage response |
| IReadOnlyDictionary<string, IEnumerable<string>> headers |
| CancellationToken cancellationToken |
Returns
| Task<IngestClient.ObjectResponseResult<T>> |
Type Parameters
| T |