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.

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.Overriding implementations should be sure to invoke base.AfterMembersCloned().

Properties
string	collection_name `[get]`
	The relative path from the root of the API at which the collection of resources of this type reside.

DateTime?	created `[get, set]`
	The date and time when the resource was created on the system.

LargeDataSubResource	data `[get]`
	An endpoint for accessing or modifying the data file attached to this resource. Also contains a LargeDataSubResource.status endpoint for retrieving information about the upload progress (such as the current AnalyzeRe.LargeDataUpload.StatusResponse.commit_progress).

IReference< DataFile >	data_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.

string	description `[get, set]`
	A user-friendly description of the resource.

string	id `[get, set]`
	The resource's unique identifier. It will be used in the request URL when requesting the resource from the server.

Dictionary< string, object >	meta_data = new Dictionary<string, object>() `[get, set]`
	Any user-defined metadata for this layer.

DateTime?	modified `[get, set]`
	The date and time when the resource was last modified on the system.

string	Path `[get]`
	The relative path to this endpoint from the root URL.

TaskStatus	status `[get, set]`
	Status of the data file associated with this resource.

string	status_message `[get, set]`
	Status message of the data file associated with this resource.

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:

Member Function Documentation

◆ AfterMembersCloned()

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.Overriding implementations should be sure to invoke base.AfterMembersCloned().

Reimplemented from AnalyzeRe.APIType.

Definition at line 33 of file APIResource_WithDataEndpoint.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

◆ collection_name

string AnalyzeRe.APIResource.collection_name

getabstractinherited

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

Implements AnalyzeRe.IAPIResource.

Definition at line 21 of file APIResource.cs.

◆ created

DateTime? AnalyzeRe.APITypes.StoredAPIResource.created

getsetinherited

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

Implements AnalyzeRe.APITypes.IStoredAPIResource.

Definition at line 19 of file StoredAPIResource.cs.

◆ data

LargeDataSubResource AnalyzeRe.APITypes.APIResource_WithDataEndpoint.data

get

An endpoint for accessing or modifying the data file attached to this resource. Also contains a LargeDataSubResource.status endpoint for retrieving information about the upload progress (such as the current AnalyzeRe.LargeDataUpload.StatusResponse.commit_progress).

Implements AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint.

Definition at line 19 of file APIResource_WithDataEndpoint.cs.

◆ data_file

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.

Implements AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint.

Definition at line 30 of file APIResource_WithDataEndpoint.cs.