C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
AnalyzeRe.APITypes.SubResourceEndpoint Class Referenceabstract

Describes an additional sub-resource available off a resource which is not actually a property of that resource. Allows APIResources to quickly define additional endpoints off their URLs which in turn support one or more REST methods. More...

Public Member Functions

void ValidateOwnerHasId ()
 Verifies the owner exists and has been POSTed, ensuring that it is safe to invoke actions on this SubResourceEndpoint.
 

Protected Member Functions

 SubResourceEndpoint (IEndpoint owner, string relativePath)
 Defines a new sub-resource or endpoint off the current resource.
 

Properties

IEndpoint Owner [get]
 The endpoint off of which this sub-endpoint exists.
 
string Path [get]
 The relative path to this endpoint from the root server URL.
 
string RelativePathFromOwner [get]
 The relative path to this endpoint from its owner.
 

Detailed Description

Describes an additional sub-resource available off a resource which is not actually a property of that resource. Allows APIResources to quickly define additional endpoints off their URLs which in turn support one or more REST methods.

Definition at line 8 of file SubResourceEndpoint.cs.

Inheritance diagram for AnalyzeRe.APITypes.SubResourceEndpoint:
AnalyzeRe.APITypes.IEndpoint AnalyzeRe.APITypes.CommandSubResource AnalyzeRe.APITypes.SubResource< T >

Constructor & Destructor Documentation

◆ SubResourceEndpoint()

AnalyzeRe.APITypes.SubResourceEndpoint.SubResourceEndpoint ( IEndpoint  owner,
string  relativePath 
)
inlineprotected

Defines a new sub-resource or endpoint off the current resource.

Parameters
ownerThe resource which owns this sub-resource
relativePathThe relative path to endpoint from its owner.

Definition at line 25 of file SubResourceEndpoint.cs.

Member Function Documentation

◆ ValidateOwnerHasId()

void AnalyzeRe.APITypes.SubResourceEndpoint.ValidateOwnerHasId ( )
inline

Verifies the owner exists and has been POSTed, ensuring that it is safe to invoke actions on this SubResourceEndpoint.

Exceptions
ArgumentExceptionIf the resource's id is null or empty.

Definition at line 34 of file SubResourceEndpoint.cs.

Property Documentation

◆ Owner

IEndpoint AnalyzeRe.APITypes.SubResourceEndpoint.Owner
get

The endpoint off of which this sub-endpoint exists.

Definition at line 12 of file SubResourceEndpoint.cs.

◆ Path

string AnalyzeRe.APITypes.SubResourceEndpoint.Path
get

The relative path to this endpoint from the root server URL.

The relative path to this endpoint from the root URL.

Implements AnalyzeRe.APITypes.IEndpoint.

Definition at line 19 of file SubResourceEndpoint.cs.

◆ RelativePathFromOwner

string AnalyzeRe.APITypes.SubResourceEndpoint.RelativePathFromOwner
get

The relative path to this endpoint from its owner.

Definition at line 15 of file SubResourceEndpoint.cs.


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