C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
AnalyzeRe.LargeDataUpload.Utilities Class Reference

Large Data Upload Utilities. More...

Static Public Member Functions

static MemoryStream GetStringStream (string input)
 Generate a byte stream from a string which can be used in the LargeStreamUpload methods.
 
static StatusResponse PollUntilDataProcessed (LargeDataSubResource dataEndpoint, AsyncParameters parameters)
 Polls the dataEndpoint until the state is no longer Processing.
 
static StatusResponse PollUntilDataProcessed (LargeDataSubResource dataEndpoint, Parameters parameters=null)
 Polls the dataEndpoint until the state is no longer Processing.
 

Properties

static bool EnableDebugLogging [get, set]
 When in debug mode, allows detailed debug logging of the data upload process.
 

Detailed Description

Large Data Upload Utilities.

Definition at line 10 of file Utilities.cs.

Member Function Documentation

◆ GetStringStream()

static MemoryStream AnalyzeRe.LargeDataUpload.Utilities.GetStringStream ( string  input)
inlinestatic

Generate a byte stream from a string which can be used in the LargeStreamUpload methods.

Parameters
inputThe string to convert to a byte stream.
Returns
A byte stream of the UTF8-encoded data in the string.

Definition at line 40 of file Utilities.cs.

◆ PollUntilDataProcessed() [1/2]

static StatusResponse AnalyzeRe.LargeDataUpload.Utilities.PollUntilDataProcessed ( LargeDataSubResource  dataEndpoint,
AsyncParameters  parameters 
)
inlinestatic

Polls the dataEndpoint until the state is no longer Processing.

Parameters
dataEndpointThe data endpoint to poll.
parametersThe AsyncParameters specifying the upload and polling behaviour, and progress and completion callbacks.
Returns
The final StatusResponse after finishing polling
Exceptions
RequestTimeoutExceptionRaised if the commit_timeout is exceeded.

Definition at line 64 of file Utilities.cs.

◆ PollUntilDataProcessed() [2/2]

static StatusResponse AnalyzeRe.LargeDataUpload.Utilities.PollUntilDataProcessed ( LargeDataSubResource  dataEndpoint,
Parameters  parameters = null 
)
inlinestatic

Polls the dataEndpoint until the state is no longer Processing.

Parameters
dataEndpointThe data endpoint to poll.
parametersThe parameters specifying the upload and polling behaviour.
Returns
The final StatusResponse after finishing polling
Exceptions
RequestTimeoutExceptionRaised if the commit_timeout is exceeded.

Definition at line 50 of file Utilities.cs.

Property Documentation

◆ EnableDebugLogging

bool AnalyzeRe.LargeDataUpload.Utilities.EnableDebugLogging
staticgetset

When in debug mode, allows detailed debug logging of the data upload process.

Very useful when debugging upload issues, very noisy when not, hence why we don't just wholesale comment-out the logs or leave them in.

Definition at line 18 of file Utilities.cs.


The documentation for this class was generated from the following file: