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

Indicates the status of a data endpoint. More...

Public Types

enum  LegacyStatus {
  Unknown = 0 , Awaiting_Upload , Uploading , Processing ,
  Success , Failed
}
 The status of a data upload which may be in progress. More...
 

Public Member Functions

virtual T ShallowCopy< T > ()
 Create a shallow copy of this object.

See also
ExtensionMethods.DeepCopy<T>

for a serializer-based copy method.

 

Protected Member Functions

virtual void AfterMembersCloned (APIType originalResource)
 Invoked following construction if the current instance has been created using a member-wise clone of some other instance. Override if your derived APIType class contains some members that should not be cloned.
 

Properties

long? bytes_uploaded [get, set]
 The number of bytes that have been uploaded by the client so far.
 
string commit_error [get, set]
 If the processing of the file failed, the error message reported by the server.
 
double? commit_progress [get, set]
 If the file is being processed, this is the percentage completion of the processing task.
 
TaskStatus status [get, set]
 The state of the data upload, as an enumeration.
 
long? total_bytes [get, set]
 Total number of bytes in the file to be uploaded.
 

Detailed Description

Indicates the status of a data endpoint.

Definition at line 6 of file StatusReponse.cs.

Inheritance diagram for AnalyzeRe.LargeDataUpload.StatusResponse:
AnalyzeRe.APIType AnalyzeRe.IAPIType

Member Enumeration Documentation

◆ LegacyStatus

The status of a data upload which may be in progress.

Enumerator
Unknown 

Cannot determine the status of this data endpoint.

Awaiting_Upload 

No data upload has been initiated. Ready for upload.

Uploading 

Data upload has been initiated, but not yet committed.

Processing 

Data has already been uploaded and is being processed.

Success 

Data has already been uploaded and successfully processed.

Failed 

Data has already been uploaded but failed processing.

Definition at line 10 of file StatusReponse.cs.

Member Function Documentation

◆ AfterMembersCloned()

virtual void AnalyzeRe.APIType.AfterMembersCloned ( APIType  originalResource)
inlineprotectedvirtualinherited

Invoked following construction if the current instance has been created using a member-wise clone of some other instance. Override if your derived APIType class contains some members that should not be cloned.

Overriding implementations should be sure to invoke base.AfterMembersCloned().

A sane question for a code reviewer to ask might be: "Why not avoid copying those members in the first place?" The answer is that there is no framework-supported method of excluding members from a MemberwiseClone. The only officially supported solution is to not use the object.MemberwiseClone method at all and instead have each class implement it's own Copy method. In our case, most objects have no need to specialize their copy implementation (even though they could - the ShallowCopy<T> method is marked virtual). It's simpler to simply "correct" any special-case members after the fact, and requires less error-prone code than if the code were responsible for ensuring no members were missed in a copy. It's also faster than any reflection-based approach, even though such an approach could benefit from custom attributes meant to exclude certain members from copying.

Reimplemented in AnalyzeRe.APITypes.APIResource_WithDataEndpoint, AnalyzeRe.APIResourceView.BaseAPIResourceView, AnalyzeRe.Distributions.CustomDistribution, AnalyzeRe.LossSets.LossSet_WithData, AnalyzeRe.Optimization.Candidate, AnalyzeRe.Optimization.OptimizationView, and AnalyzeRe.StaticSimulation.

Definition at line 37 of file APIType.cs.

◆ ShallowCopy< T >()

virtual T AnalyzeRe.APIType.ShallowCopy< T > ( )
inlinevirtualinherited

Create a shallow copy of this object.

See also
ExtensionMethods.DeepCopy<T>

for a serializer-based copy method.

Returns
A shallow copy of this object.

If this object contains any members that reference the current object (this), the class should override this method to avoid cloning a reference to the old class.

Implements AnalyzeRe.IAPIType.

Type Constraints
T :IAPIType 

Definition at line 14 of file APIType.cs.

Property Documentation

◆ bytes_uploaded

long? AnalyzeRe.LargeDataUpload.StatusResponse.bytes_uploaded
getset

The number of bytes that have been uploaded by the client so far.

Definition at line 54 of file StatusReponse.cs.

◆ commit_error

string AnalyzeRe.LargeDataUpload.StatusResponse.commit_error
getset

If the processing of the file failed, the error message reported by the server.

Definition at line 68 of file StatusReponse.cs.

◆ commit_progress

double? AnalyzeRe.LargeDataUpload.StatusResponse.commit_progress
getset

If the file is being processed, this is the percentage completion of the processing task.

Definition at line 63 of file StatusReponse.cs.

◆ status

TaskStatus AnalyzeRe.LargeDataUpload.StatusResponse.status
getset

The state of the data upload, as an enumeration.

Definition at line 50 of file StatusReponse.cs.

◆ total_bytes

long? AnalyzeRe.LargeDataUpload.StatusResponse.total_bytes
getset

Total number of bytes in the file to be uploaded.

Definition at line 58 of file StatusReponse.cs.


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