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

Minor extension to the base APIResource class that adds a "/data" sub-resource, since this is common to several resources. 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. More...

 

Public Attributes

LargeDataSubResource data
 An endpoint for accessing or modifying the data file attached to this resource. More...
 
string Path => API.GetResourcePath(this)
 The relative path to this endpoint from the root URL. More...
 

Protected Member Functions

override void AfterMembersCloned (APIType _)
 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. More...
 

Properties

abstract string collection_name [get]
 The relative path from the root of the API at which the collection of resources of this type reside. More...
 
DateTime created [get, set]
 The date and time when the resource was created on the system. More...
 
IReference< DataFiledata_file [get, set]
 A reference to the data attached to this resource. This field will automatically be created if you initiate an upload using the data property, or this can be set to reference an existing file on the server to immediately initiate the commit phase of this resource. More...
 
string description [get, set]
 A user-friendly description of the resource. More...
 
string id [get, set]
 The resource's unique identifier. It will be used in the request URL when requesting the resource from the server. More...
 
Dictionary< string, object > meta_data [get, set]
 Any user-defined metadata for this layer. More...
 
DateTime modified [get, set]
 The date and time when the resource was last modified on the system. More...
 
double progress [get, set]
 The progress made in validating this resource. Usually a number between 0 and 1 (where 1 means 100% completion). Progress may not be available for certain resource types. More...
 
TaskStatus status [get, set]
 Status of the data file associated with this resource. More...
 
string status_message [get, set]
 Status message of the data file associated with this resource. More...
 

Detailed Description

Minor extension to the base APIResource class that adds a "/data" sub-resource, since this is common to several resources.

Definition at line 8 of file APIResource_WithDataEndpoint.cs.

Inheritance diagram for AnalyzeRe.APITypes.APIResource_WithDataEndpoint:
AnalyzeRe.APITypes.StoredAPIResource_WithStatus AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint AnalyzeRe.APITypes.StoredAPIResource AnalyzeRe.APITypes.IStoredAPIResource_WithStatus AnalyzeRe.APITypes.IStoredAPIResource_WithStatus AnalyzeRe.APIResource AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APIType AnalyzeRe.IAPIResource AnalyzeRe.IAPIResource AnalyzeRe.IAPIResource AnalyzeRe.IAPIResource AnalyzeRe.APITypes.IEndpoint AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.IAPIType AnalyzeRe.IAPIType AnalyzeRe.EventCatalog AnalyzeRe.ExchangeRates.ExchangeRateTable

Member Function Documentation

override void AnalyzeRe.APITypes.APIResource_WithDataEndpoint.AfterMembersCloned ( APIType  _)
inlineprotectedvirtual

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.

Reimplemented from AnalyzeRe.APIType.

Definition at line 28 of file APIResource_WithDataEndpoint.cs.

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.

Member Data Documentation

LargeDataSubResource AnalyzeRe.APITypes.APIResource_WithDataEndpoint.data
Initial value:
=> _dataEndpoint ??
(_dataEndpoint = new LargeDataSubResource(this))

An endpoint for accessing or modifying the data file attached to this resource.

Definition at line 16 of file APIResource_WithDataEndpoint.cs.

string AnalyzeRe.APIResource.Path => API.GetResourcePath(this)
inherited

The relative path to this endpoint from the root URL.

Exceptions
System.ArgumentExceptionIf this resource does not have an id.

Definition at line 27 of file APIResource.cs.

Property Documentation

abstract string AnalyzeRe.APIResource.collection_name
getinherited

The relative path from the root of the API at which the collection of resources of this type reside.

Definition at line 21 of file APIResource.cs.

DateTime AnalyzeRe.APITypes.StoredAPIResource.created
getsetinherited

The date and time when the resource was created on the system.

Definition at line 19 of file StoredAPIResource.cs.

IReference<DataFile> AnalyzeRe.APITypes.APIResource_WithDataEndpoint.data_file
getset

A reference to the data attached to this resource. This field will automatically be created if you initiate an upload using the data property, or this can be set to reference an existing file on the server to immediately initiate the commit phase of this resource.

Definition at line 25 of file APIResource_WithDataEndpoint.cs.

string AnalyzeRe.APITypes.StoredAPIResource.description
getsetinherited

A user-friendly description of the resource.

Definition at line 14 of file StoredAPIResource.cs.

string AnalyzeRe.APIResource.id
getsetinherited

The resource's unique identifier. It will be used in the request URL when requesting the resource from the server.

Definition at line 16 of file APIResource.cs.

Dictionary<string, object> AnalyzeRe.APITypes.StoredAPIResource.meta_data
getsetinherited

Any user-defined metadata for this layer.

Definition at line 30 of file StoredAPIResource.cs.

DateTime AnalyzeRe.APITypes.StoredAPIResource.modified
getsetinherited

The date and time when the resource was last modified on the system.

Definition at line 24 of file StoredAPIResource.cs.

double AnalyzeRe.APITypes.StoredAPIResource_WithStatus.progress
getsetinherited

The progress made in validating this resource. Usually a number between 0 and 1 (where 1 means 100% completion). Progress may not be available for certain resource types.

Definition at line 28 of file StoredAPIResource_WithStatus.cs.

TaskStatus AnalyzeRe.APITypes.StoredAPIResource_WithStatus.status
getsetinherited

Status of the data file associated with this resource.

Definition at line 16 of file StoredAPIResource_WithStatus.cs.

string AnalyzeRe.APITypes.StoredAPIResource_WithStatus.status_message
getsetinherited

Status message of the data file associated with this resource.

Definition at line 21 of file StoredAPIResource_WithStatus.cs.


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