\r\n

51Degrees Pipeline Java  4.4

51Degrees Pipeline for Java

fiftyone.pipeline.engines.flowelements.CloudPipelineBuilderBase< TBuilder extends CloudPipelineBuilderBase< TBuilder > Class Template Reference abstract

Detailed Description

Base class for pipeline builders that will produce a pipeline with specific flow elements.

Parameters
<TBuilder> - the builder type

Inheritance diagram for fiftyone.pipeline.engines.flowelements.CloudPipelineBuilderBase< TBuilder extends CloudPipelineBuilderBase< TBuilder >:

[legend]

Collaboration diagram for fiftyone.pipeline.engines.flowelements.CloudPipelineBuilderBase< TBuilder extends CloudPipelineBuilderBase< TBuilder >:

[legend]

Public Member Functions

 CloudPipelineBuilderBase (ILoggerFactory loggerFactory)
Construct a new instance. More...
TBuilder  setEndPoint (String url)
Set the endpoint to use when calling the cloud service. More...
TBuilder  setDataEndpoint (String url)
Set the URL for the data endpoint to be called during processing. More...
TBuilder  setPropertiesEndpoint (String propertiesEndpoint)
Set the URL for the properties endpoint to be called when setting up the engine. More...
TBuilder  setEvidenceKeysEndpoint (String evidenceKeysEndpoint)
Set the URL for the evidence keys endpoint to be called when setting up the engine. More...
TBuilder  setResourceKey (String key)
Set the resource key to be used when calling the endpoints. More...
TBuilder  setLicenseKey (String key)
Set the license key to be used when calling the endpoints. More...
TBuilder  setCloudRequestOrigin (String cloudRequestOrigin)
The value to set for the Origin header when making requests to the cloud service. More...

Public Member Functions inherited from fiftyone.pipeline.engines.flowelements.PrePackagedPipelineBuilderBase< TBuilder >

 PrePackagedPipelineBuilderBase ()
Construct a new instance using the default ILoggerFactory implementation returned by the LoggerFactory#getILoggerFactory() method.
 PrePackagedPipelineBuilderBase (ILoggerFactory loggerFactory)
Construct a new instance. More...
TBuilder  useLazyLoading ()
Enable lazy loading of results. More...
TBuilder  useLazyLoading (long timeoutMillis)
Enable lazy loading of results. More...
TBuilder  useResultsCache ()
Enable caching of results. More...
TBuilder  useResultsCache (int size)
Enable caching of results. More...

Protected Attributes

String  url = ""
String  dataEndpoint = ""
String  propertiesEndpoint = ""
String  evidenceKeysEndpoint = ""
String  resourceKey = ""
String  licenseKey = "" String  cloudRequestOrigin = ""

Protected Attributes inherited from fiftyone.pipeline.engines.flowelements.PrePackagedPipelineBuilderBase< TBuilder >

boolean  lazyLoading boolean  resultsCache long  lazyLoadingTimeoutMillis int  resultsCacheSize

Constructor & Destructor Documentation

◆ CloudPipelineBuilderBase()

fiftyone.pipeline.engines.flowelements.CloudPipelineBuilderBase< TBuilder extends CloudPipelineBuilderBase< TBuilder >.CloudPipelineBuilderBase ( ILoggerFactory   loggerFactory )

Construct a new instance.

Parameters
loggerFactory - the ILoggerFactory used to create any loggers required by instances being built by the builder

Member Function Documentation

◆ setCloudRequestOrigin()

TBuilder fiftyone.pipeline.engines.flowelements.CloudPipelineBuilderBase< TBuilder extends CloudPipelineBuilderBase< TBuilder >.setCloudRequestOrigin ( String   cloudRequestOrigin )

The value to set for the Origin header when making requests to the cloud service.

This is used by the cloud service to check that the request is being made from a origin matching those allowed by the resource key. For more detail, see the 'Request Headers' section in the cloud documentation.

Parameters
cloudRequestOrigin - the value to set the origin header to
Returns
this builder

◆ setDataEndpoint()

TBuilder fiftyone.pipeline.engines.flowelements.CloudPipelineBuilderBase< TBuilder extends CloudPipelineBuilderBase< TBuilder >.setDataEndpoint ( String   url )

Set the URL for the data endpoint to be called during processing.

Parameters
url - data URL
Returns
this builder

◆ setEndPoint()

TBuilder fiftyone.pipeline.engines.flowelements.CloudPipelineBuilderBase< TBuilder extends CloudPipelineBuilderBase< TBuilder >.setEndPoint ( String   url )

Set the endpoint to use when calling the cloud service.

This will also set the data, properties, and evidence keys endpoints using this as the base URL.

Parameters
url - endpoint URL
Returns
this builder

◆ setEvidenceKeysEndpoint()

TBuilder fiftyone.pipeline.engines.flowelements.CloudPipelineBuilderBase< TBuilder extends CloudPipelineBuilderBase< TBuilder >.setEvidenceKeysEndpoint ( String   evidenceKeysEndpoint )

Set the URL for the evidence keys endpoint to be called when setting up the engine.

Parameters
evidenceKeysEndpoint - evidence keys URL
Returns
this builder

◆ setLicenseKey()

TBuilder fiftyone.pipeline.engines.flowelements.CloudPipelineBuilderBase< TBuilder extends CloudPipelineBuilderBase< TBuilder >.setLicenseKey ( String   key )

Set the license key to be used when calling the endpoints.

Parameters
key - license key
Returns
this builder

◆ setPropertiesEndpoint()

TBuilder fiftyone.pipeline.engines.flowelements.CloudPipelineBuilderBase< TBuilder extends CloudPipelineBuilderBase< TBuilder >.setPropertiesEndpoint ( String   propertiesEndpoint )

Set the URL for the properties endpoint to be called when setting up the engine.

Parameters
propertiesEndpoint - properties URL
Returns
this builder

◆ setResourceKey()

TBuilder fiftyone.pipeline.engines.flowelements.CloudPipelineBuilderBase< TBuilder extends CloudPipelineBuilderBase< TBuilder >.setResourceKey ( String   key )

Set the resource key to be used when calling the endpoints.

Parameters
key - resource key
Returns
this builder
On This Page

Generated by doxygen 1.8.15