Class DataPortClient

Data port client. This api client contains all general and data port specific methods.

Inheritance
System.Object
ClientBase
DataPortClient
Implements
System.IDisposable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Simplic.Cloud.API.DataPort
Assembly: Simplic.Cloud.API.DataPort.dll
Syntax
public class DataPortClient : ClientBase, IDisposable

Constructors

| Improve this Doc View Source

DataPortClient()

Initialize new client.

Declaration
public DataPortClient()
| Improve this Doc View Source

DataPortClient(IClient)

Initialize client and inherit the authentication

Declaration
public DataPortClient(IClient client)
Parameters
Type Name Description
IClient client

Client instance
| Improve this Doc View Source

DataPortClient(String)

Initialize client with different url. DefaultUrl

Declaration
public DataPortClient(string url)
Parameters
Type Name Description
System.String url

Unique url

Methods

| Improve this Doc View Source

EnqueueFile(Byte[], String, String)

Enqueue file for processing in data port web api

Declaration
public async Task EnqueueFile(byte[] blob, string transformerName, string fileName)
Parameters
Type Name Description
System.Byte[] blob

Blob to enqueue
System.String transformerName
System.String fileName
Returns
Type Description
System.Threading.Tasks.Task
Exceptions
Type Condition
ApiException

If posting the multipart content is fails
| Improve this Doc View Source

GetResult(Guid)

Get data port result

Declaration
public async Task<TransformationResultResponse> GetResult(Guid queueItemId)
Parameters
Type Name Description
System.Guid queueItemId

Unique queue item
Returns
Type Description
System.Threading.Tasks.Task<TransformationResultResponse>

Result instance
| Improve this Doc View Source

GetResultQueueItems()

Get pending result queue items

Declaration
public async Task<IList<TransformationResultQueueItemResponse>> GetResultQueueItems()
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IList<TransformationResultQueueItemResponse>>
Exceptions
Type Condition
ApiException

Get request failed
| Improve this Doc View Source

RemoveResultQueueItem(Guid)

Remove result queue item

Declaration
public async Task RemoveResultQueueItem(Guid queueItemId)
Parameters
Type Name Description
System.Guid queueItemId

Unique queue item id
Returns
Type Description
System.Threading.Tasks.Task

Async result

Implements

System.IDisposable