\r\n

51Degrees Pipeline .NET  4.1

51Degrees Pipeline for .NET

FiftyOne.Pipeline.Engines.FlowElements.CloudPipelineBuilderBase< TBuilder > Class Template Reference

Detailed Description

Base class for cloud pipeline builders.

Sets the options required to access the cloud service including endpoints and resource keys.

Template Parameters
TBuilder -
Type Constraints
TBuilder :CloudPipelineBuilderBase<TBuilder> 

Inheritance diagram for FiftyOne.Pipeline.Engines.FlowElements.CloudPipelineBuilderBase< TBuilder >:

[legend]

Collaboration diagram for FiftyOne.Pipeline.Engines.FlowElements.CloudPipelineBuilderBase< TBuilder >:

[legend]

Public Member Functions

 CloudPipelineBuilderBase (ILoggerFactory loggerFactory)
Constructor More...
TBuilder  SetEndPoint (string url)
Set the base path for the cloud service. More...
TBuilder  SetJSONEndpoint (string url)
Set the URL to the JSON endpoint on the cloud service. More...
TBuilder  SetPropertiesEndpoint (string propertiesEndpoint)
Set the URL to the AccessibleProperties endpoint on the cloud service. More...
TBuilder  SetEvidenceKeysEndpoint (string evidenceKeysEndpoint)
Set the URL to the EvidenceKeys endpoint on the cloud service. More...
TBuilder  SetResourceKey (string key)
Set the resource key which will be used to query the cloud service. More...
TBuilder  SetLicenseKey (string key)
Set the license key or keys to be used when querying the cloud service. More...

Public Member Functions inherited from FiftyOne.Pipeline.Engines.FlowElements.PrePackagedPipelineBuilderBase< TBuilder >

 PrePackagedPipelineBuilderBase (ILoggerFactory loggerFactory)
Constructor More...
TBuilder  UseLazyLoading ()
Enable lazy loading of geo location results. More...
TBuilder  UseLazyLoading (TimeSpan timeout)
Enable lazy loading of geo location results. More...
TBuilder  UseLazyLoading (CancellationToken cancellationToken)
Enable lazy loading of geo location results. More...
TBuilder  UseLazyLoading (TimeSpan timeout, CancellationToken cancellationToken)
Enable lazy loading of geo location results. More...
TBuilder  UseResultsCache ()
Enable caching of geo location results. More...
TBuilder  UseResultsCache (int size)
Enable caching of geo location results. More...

Public Member Functions inherited from FiftyOne.Pipeline.Core.FlowElements.PipelineBuilderBase< TBuilder >

 PipelineBuilderBase (ILoggerFactory loggerFactory)
Create a new PipelineBuilderBase<T> instance. More...
virtual IPipeline  Build ()
Build the pipeline More...
T  AddFlowElement (IFlowElement element)
Add the specified IFlowElement to the pipeline. More...
T  AddFlowElementsParallel (params IFlowElement[] elements)
Add the specified IFlowElement array to the pipeline. More...
T  SetAutoDisposeElements (bool autoDispose)
Configure the Pipeline to either call dispose on it's child FlowElements when it is disposed or not. More...
T  SetSuppressProcessException (bool suppressExceptions)
Configure the Pipeline to either suppress exceptions added to IFlowData.Errors during processing or to throw them as an aggregate exception once processing is complete. More...

Properties

string  Url = string.Empty [get, set]
The URL to the JSON resource on the cloud service. More...
string  PropertiesEndpoint = string.Empty [get, set]
The URL for the AccessileProperties endpoint on the cloud service. More...
string  EvidenceKeysEndpoint = string.Empty [get, set]
The URL for the EvidenceKeys endpoint on the cloud service. More...
string  ResourceKey = string.Empty [get, set]
The resource key used to access the cloud service. More...
string  LicenceKey = string.Empty [get, set]
Optional license keys for additional products. More...

Properties inherited from FiftyOne.Pipeline.Engines.FlowElements.PrePackagedPipelineBuilderBase< TBuilder >

bool  LazyLoading = false [get, set]
bool  ResultsCache = false [get, set]
TimeSpan  LazyLoadingTimeout = TimeSpan.FromSeconds(5) [get, set]
CancellationToken  LazyLoadingCancellationToken = default(CancellationToken) [get, set]
int  ResultsCacheSize = 1000 [get, set]

Properties inherited from FiftyOne.Pipeline.Core.FlowElements.PipelineBuilderBase< TBuilder >

List< IFlowElement >  FlowElements [get]
The elements to be added to the pipeline More...
ILogger< T >  Logger [get]
Logger More...
ILoggerFactory  LoggerFactory [get]
A factory used to create logger instances. More...

Constructor & Destructor Documentation

◆ CloudPipelineBuilderBase()

Constructor

Parameters
loggerFactory - The logger factory to use.

Member Function Documentation

◆ SetEndPoint()

TBuilder FiftyOne.Pipeline.Engines.FlowElements.CloudPipelineBuilderBase< TBuilder >.SetEndPoint ( string   url )

Set the base path for the cloud service.

This will update the URL for the JSON endpoint and the AccessileProperties endpoint.

Parameters
url - The base URL to use.
Returns
This builder

◆ SetEvidenceKeysEndpoint()

TBuilder FiftyOne.Pipeline.Engines.FlowElements.CloudPipelineBuilderBase< TBuilder >.SetEvidenceKeysEndpoint ( string   evidenceKeysEndpoint )

Set the URL to the EvidenceKeys endpoint on the cloud service.

Parameters
evidenceKeysEndpoint - The URL to use
Returns
This builder

◆ SetJSONEndpoint()

TBuilder FiftyOne.Pipeline.Engines.FlowElements.CloudPipelineBuilderBase< TBuilder >.SetJSONEndpoint ( string   url )

Set the URL to the JSON endpoint on the cloud service.

Parameters
url - The URL which points to the JSON endpoint.
Returns
This builder

◆ SetLicenseKey()

TBuilder FiftyOne.Pipeline.Engines.FlowElements.CloudPipelineBuilderBase< TBuilder >.SetLicenseKey ( string   key )

Set the license key or keys to be used when querying the cloud service.

This is an optional method to pass additional license keys not configured when obtaining a resource key.

Parameters
key -
Returns
This builder

◆ SetPropertiesEndpoint()

TBuilder FiftyOne.Pipeline.Engines.FlowElements.CloudPipelineBuilderBase< TBuilder >.SetPropertiesEndpoint ( string   propertiesEndpoint )

Set the URL to the AccessibleProperties endpoint on the cloud service.

Parameters
propertiesEndpoint - The URL to use
Returns
This builder

◆ SetResourceKey()

TBuilder FiftyOne.Pipeline.Engines.FlowElements.CloudPipelineBuilderBase< TBuilder >.SetResourceKey ( string   key )

Set the resource key which will be used to query the cloud service.

Obtain a resource key @ https://configure.51degrees.com

Parameters
key - The resource key to use
Returns
This builder

Property Documentation

◆ EvidenceKeysEndpoint

string FiftyOne.Pipeline.Engines.FlowElements.CloudPipelineBuilderBase< TBuilder >.EvidenceKeysEndpoint = string.Empty
get set protected

The URL for the EvidenceKeys endpoint on the cloud service.

◆ LicenceKey

string FiftyOne.Pipeline.Engines.FlowElements.CloudPipelineBuilderBase< TBuilder >.LicenceKey = string.Empty
get set protected

Optional license keys for additional products.

◆ PropertiesEndpoint

string FiftyOne.Pipeline.Engines.FlowElements.CloudPipelineBuilderBase< TBuilder >.PropertiesEndpoint = string.Empty
get set protected

The URL for the AccessileProperties endpoint on the cloud service.

◆ ResourceKey

string FiftyOne.Pipeline.Engines.FlowElements.CloudPipelineBuilderBase< TBuilder >.ResourceKey = string.Empty
get set protected

The resource key used to access the cloud service.

This is required.

◆ Url

get set protected

The URL to the JSON resource on the cloud service.

On This Page