C# Client Library
A C# Client Library for the AnalyzeRe REST API
AnalyzeRe.LargeDataUpload_ExtensionMethods Class Reference

LargeDataUpload extension methods for LargeDataSubResource classes More...

Static Public Member Functions

static void LargeFileUpload (this LargeDataSubResource dataEndpoint, string filePath, Parameters parameters=null)
 Open the specified file and upload its contents to this dataEndpoint. More...
 
static void LargeFileUpload_Async (this LargeDataSubResource dataEndpoint, string filePath, AsyncParameters parameters=null)
 Asynchronously opens the specified file and uploads its contents to this dataEndpoint. More...
 
static void LargeStreamUpload (this LargeDataSubResource dataEndpoint, Stream dataStream, Parameters parameters=null, long? dataSize=null)
 Uploads the specified data stream to this dataEndpoint. More...
 
static void LargeStreamUpload_Async (this LargeDataSubResource dataEndpoint, Stream dataStream, AsyncParameters parameters=null, long? dataSize=null)
 Asynchronously uploads the specified data stream to this dataEndpoint. More...
 

Static Public Attributes

const int DefaultBufferSize = 4096
 Default buffer size used for loading data from streams. More...
 
static RequestParameters GzipEncodingHeader
 The header used to indicate that data is being gzipped in transit. More...
 

Detailed Description

LargeDataUpload extension methods for LargeDataSubResource classes

Definition at line 19 of file LargeDataUpload_ExtensionMethods.cs.

Member Function Documentation

◆ LargeFileUpload()

static void AnalyzeRe.LargeDataUpload_ExtensionMethods.LargeFileUpload ( this LargeDataSubResource  dataEndpoint,
string  filePath,
Parameters  parameters = null 
)
inlinestatic

Open the specified file and upload its contents to this dataEndpoint.

Parameters
dataEndpointThe data endpoint to upload the file contents to.
filePathThe path of the file to stream data from.
parametersThe large upload parameters to use.

Definition at line 84 of file LargeDataUpload_ExtensionMethods.cs.

◆ LargeFileUpload_Async()

static void AnalyzeRe.LargeDataUpload_ExtensionMethods.LargeFileUpload_Async ( this LargeDataSubResource  dataEndpoint,
string  filePath,
AsyncParameters  parameters = null 
)
inlinestatic

Asynchronously opens the specified file and uploads its contents to this dataEndpoint.

Parameters
dataEndpointThe data endpoint to upload the file contents to.
filePathThe path of the file to stream data from.
parametersThe large upload parameters to use.

Definition at line 31 of file LargeDataUpload_ExtensionMethods.cs.

◆ LargeStreamUpload()

static void AnalyzeRe.LargeDataUpload_ExtensionMethods.LargeStreamUpload ( this LargeDataSubResource  dataEndpoint,
Stream  dataStream,
Parameters  parameters = null,
long?  dataSize = null 
)
inlinestatic

Uploads the specified data stream to this dataEndpoint.

Parameters
dataEndpointThe data endpoint to upload the file contents to.
dataStreamThe stream to retrieve data from.
parametersThe large upload parameters to use.
dataSize(optional) The total number of bytes of data to read - required if you wish to stop before reaching the end of the stream, or if you wish to read the entire stream, but the stream does not support the '.Length' property (such that the stream size can not automatically be computed in advance).

Definition at line 102 of file LargeDataUpload_ExtensionMethods.cs.

◆ LargeStreamUpload_Async()

static void AnalyzeRe.LargeDataUpload_ExtensionMethods.LargeStreamUpload_Async ( this LargeDataSubResource  dataEndpoint,
Stream  dataStream,
AsyncParameters  parameters = null,
long?  dataSize = null 
)
inlinestatic

Asynchronously uploads the specified data stream to this dataEndpoint.

Parameters
dataEndpointThe data endpoint to upload the file contents to.
dataStreamThe stream to retrieve data from.
parametersThe large upload parameters to use.
dataSize(optional) The total number of bytes of data to read - required if you wish to stop before reaching the end of the stream, or if you wish to read the entire stream, but the stream does not support the '.Length' property (such that the stream size can not automatically be computed in advance).

Definition at line 60 of file LargeDataUpload_ExtensionMethods.cs.

Member Data Documentation

◆ DefaultBufferSize

const int AnalyzeRe.LargeDataUpload_ExtensionMethods.DefaultBufferSize = 4096
static

Default buffer size used for loading data from streams.

Definition at line 22 of file LargeDataUpload_ExtensionMethods.cs.

◆ GzipEncodingHeader

RequestParameters AnalyzeRe.LargeDataUpload_ExtensionMethods.GzipEncodingHeader
static
Initial value:
= new RequestParameters(new[]
{
new Parameter
{
Type = ParameterType.HttpHeader,
Name = "Content-Encoding",
Value = "gzip"
}
})

The header used to indicate that data is being gzipped in transit.

Definition at line 482 of file LargeDataUpload_ExtensionMethods.cs.


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