Synapseml  0.10.0
Public Member Functions | Static Public Member Functions | List of all members
Synapse.ML.Geospatial.ReverseAddressGeocoder Class Reference

ReverseAddressGeocoder implements ReverseAddressGeocoder More...

Inheritance diagram for Synapse.ML.Geospatial.ReverseAddressGeocoder:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Geospatial.ReverseAddressGeocoder:
Collaboration graph
[legend]

Public Member Functions

 ReverseAddressGeocoder ()
 Creates a ReverseAddressGeocoder without any parameters. More...
 
 ReverseAddressGeocoder (string uid)
 Creates a ReverseAddressGeocoder with a UID that is used to give the ReverseAddressGeocoder a unique ID. More...
 
ReverseAddressGeocoder SetBackoffs (int[] value)
 Sets value for backoffs More...
 
ReverseAddressGeocoder SetConcurrency (int value)
 Sets value for concurrency More...
 
ReverseAddressGeocoder SetConcurrentTimeout (double value)
 Sets value for concurrentTimeout More...
 
ReverseAddressGeocoder SetErrorCol (string value)
 Sets value for errorCol More...
 
ReverseAddressGeocoder SetInitialPollingDelay (int value)
 Sets value for initialPollingDelay More...
 
ReverseAddressGeocoder SetLatitude (double[] value)
 Sets value for latitude More...
 
ReverseAddressGeocoder SetLatitudeCol (string value)
 Sets value for latitude column More...
 
ReverseAddressGeocoder SetLongitude (double[] value)
 Sets value for longitude More...
 
ReverseAddressGeocoder SetLongitudeCol (string value)
 Sets value for longitude column More...
 
ReverseAddressGeocoder SetMaxPollingRetries (int value)
 Sets value for maxPollingRetries More...
 
ReverseAddressGeocoder SetOutputCol (string value)
 Sets value for outputCol More...
 
ReverseAddressGeocoder SetPollingDelay (int value)
 Sets value for pollingDelay More...
 
ReverseAddressGeocoder SetSubscriptionKey (string value)
 Sets value for subscriptionKey More...
 
ReverseAddressGeocoder SetSubscriptionKeyCol (string value)
 Sets value for subscriptionKey column More...
 
ReverseAddressGeocoder SetSuppressMaxRetriesExceededException (bool value)
 Sets value for suppressMaxRetriesExceededException More...
 
ReverseAddressGeocoder SetTimeout (double value)
 Sets value for timeout More...
 
ReverseAddressGeocoder SetUrl (string value)
 Sets value for url More...
 
int [] GetBackoffs ()
 Gets backoffs value More...
 
int GetConcurrency ()
 Gets concurrency value More...
 
double GetConcurrentTimeout ()
 Gets concurrentTimeout value More...
 
string GetErrorCol ()
 Gets errorCol value More...
 
int GetInitialPollingDelay ()
 Gets initialPollingDelay value More...
 
double [] GetLatitude ()
 Gets latitude value More...
 
double [] GetLongitude ()
 Gets longitude value More...
 
int GetMaxPollingRetries ()
 Gets maxPollingRetries value More...
 
string GetOutputCol ()
 Gets outputCol value More...
 
int GetPollingDelay ()
 Gets pollingDelay value More...
 
string GetSubscriptionKey ()
 Gets subscriptionKey value More...
 
bool GetSuppressMaxRetriesExceededException ()
 Gets suppressMaxRetriesExceededException value More...
 
double GetTimeout ()
 Gets timeout value More...
 
string GetUrl ()
 Gets url value More...
 
void Save (string path)
 Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala. More...
 
JavaMLWriter Write ()
 
Returns
a JavaMLWriter instance for this ML instance.

 
JavaMLReader< ReverseAddressGeocoderRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

static ReverseAddressGeocoder Load (string path)
 Loads the ReverseAddressGeocoder that was previously saved using Save(string). More...
 

Detailed Description

ReverseAddressGeocoder implements ReverseAddressGeocoder

Constructor & Destructor Documentation

◆ ReverseAddressGeocoder() [1/2]

Synapse.ML.Geospatial.ReverseAddressGeocoder.ReverseAddressGeocoder ( )
inline

Creates a ReverseAddressGeocoder without any parameters.

◆ ReverseAddressGeocoder() [2/2]

Synapse.ML.Geospatial.ReverseAddressGeocoder.ReverseAddressGeocoder ( string  uid)
inline

Creates a ReverseAddressGeocoder with a UID that is used to give the ReverseAddressGeocoder a unique ID.

Parameters
uidAn immutable unique ID for the object and its derivatives.

Member Function Documentation

◆ GetBackoffs()

int [] Synapse.ML.Geospatial.ReverseAddressGeocoder.GetBackoffs ( )

Gets backoffs value

Returns
backoffs: array of backoffs to use in the handler

◆ GetConcurrency()

int Synapse.ML.Geospatial.ReverseAddressGeocoder.GetConcurrency ( )

Gets concurrency value

Returns
concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

double Synapse.ML.Geospatial.ReverseAddressGeocoder.GetConcurrentTimeout ( )

Gets concurrentTimeout value

Returns
concurrentTimeout: max number seconds to wait on futures if concurrency >= 1

◆ GetErrorCol()

string Synapse.ML.Geospatial.ReverseAddressGeocoder.GetErrorCol ( )

Gets errorCol value

Returns
errorCol: column to hold http errors

◆ GetInitialPollingDelay()

int Synapse.ML.Geospatial.ReverseAddressGeocoder.GetInitialPollingDelay ( )

Gets initialPollingDelay value

Returns
initialPollingDelay: number of milliseconds to wait before first poll for result

◆ GetLatitude()

double [] Synapse.ML.Geospatial.ReverseAddressGeocoder.GetLatitude ( )

Gets latitude value

Returns
latitude: the latitude of location

◆ GetLongitude()

double [] Synapse.ML.Geospatial.ReverseAddressGeocoder.GetLongitude ( )

Gets longitude value

Returns
longitude: the longitude of location

◆ GetMaxPollingRetries()

int Synapse.ML.Geospatial.ReverseAddressGeocoder.GetMaxPollingRetries ( )

Gets maxPollingRetries value

Returns
maxPollingRetries: number of times to poll

◆ GetOutputCol()

string Synapse.ML.Geospatial.ReverseAddressGeocoder.GetOutputCol ( )

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetPollingDelay()

int Synapse.ML.Geospatial.ReverseAddressGeocoder.GetPollingDelay ( )

Gets pollingDelay value

Returns
pollingDelay: number of milliseconds to wait between polling

◆ GetSubscriptionKey()

string Synapse.ML.Geospatial.ReverseAddressGeocoder.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns
subscriptionKey: the API key to use

◆ GetSuppressMaxRetriesExceededException()

bool Synapse.ML.Geospatial.ReverseAddressGeocoder.GetSuppressMaxRetriesExceededException ( )

Gets suppressMaxRetriesExceededException value

Returns
suppressMaxRetriesExceededException: set true to suppress the maxumimum retries exception and report in the error column

◆ GetTimeout()

double Synapse.ML.Geospatial.ReverseAddressGeocoder.GetTimeout ( )

Gets timeout value

Returns
timeout: number of seconds to wait before closing the connection

◆ GetUrl()

string Synapse.ML.Geospatial.ReverseAddressGeocoder.GetUrl ( )

Gets url value

Returns
url: Url of the service

◆ Load()

static ReverseAddressGeocoder Synapse.ML.Geospatial.ReverseAddressGeocoder.Load ( string  path)
static

Loads the ReverseAddressGeocoder that was previously saved using Save(string).

Parameters
pathThe path the previous ReverseAddressGeocoder was saved to
Returns
New ReverseAddressGeocoder object, loaded from path.

◆ Read()

JavaMLReader<ReverseAddressGeocoder> Synapse.ML.Geospatial.ReverseAddressGeocoder.Read ( )

Get the corresponding JavaMLReader instance.

Returns
an JavaMLReader<ReverseAddressGeocoder> instance for this ML instance.

◆ Save()

void Synapse.ML.Geospatial.ReverseAddressGeocoder.Save ( string  path)

Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala.

Parameters
pathThe path to save the object to

◆ SetBackoffs()

ReverseAddressGeocoder Synapse.ML.Geospatial.ReverseAddressGeocoder.SetBackoffs ( int []  value)

Sets value for backoffs

Parameters
valuearray of backoffs to use in the handler
Returns
New ReverseAddressGeocoder object

◆ SetConcurrency()

ReverseAddressGeocoder Synapse.ML.Geospatial.ReverseAddressGeocoder.SetConcurrency ( int  value)

Sets value for concurrency

Parameters
valuemax number of concurrent calls
Returns
New ReverseAddressGeocoder object

◆ SetConcurrentTimeout()

ReverseAddressGeocoder Synapse.ML.Geospatial.ReverseAddressGeocoder.SetConcurrentTimeout ( double  value)

Sets value for concurrentTimeout

Parameters
valuemax number seconds to wait on futures if concurrency >= 1
Returns
New ReverseAddressGeocoder object

◆ SetErrorCol()

ReverseAddressGeocoder Synapse.ML.Geospatial.ReverseAddressGeocoder.SetErrorCol ( string  value)

Sets value for errorCol

Parameters
valuecolumn to hold http errors
Returns
New ReverseAddressGeocoder object

◆ SetInitialPollingDelay()

ReverseAddressGeocoder Synapse.ML.Geospatial.ReverseAddressGeocoder.SetInitialPollingDelay ( int  value)

Sets value for initialPollingDelay

Parameters
valuenumber of milliseconds to wait before first poll for result
Returns
New ReverseAddressGeocoder object

◆ SetLatitude()

ReverseAddressGeocoder Synapse.ML.Geospatial.ReverseAddressGeocoder.SetLatitude ( double []  value)

Sets value for latitude

Parameters
valuethe latitude of location
Returns
New ReverseAddressGeocoder object

◆ SetLatitudeCol()

ReverseAddressGeocoder Synapse.ML.Geospatial.ReverseAddressGeocoder.SetLatitudeCol ( string  value)

Sets value for latitude column

Parameters
valuethe latitude of location
Returns
New ReverseAddressGeocoder object

◆ SetLongitude()

ReverseAddressGeocoder Synapse.ML.Geospatial.ReverseAddressGeocoder.SetLongitude ( double []  value)

Sets value for longitude

Parameters
valuethe longitude of location
Returns
New ReverseAddressGeocoder object

◆ SetLongitudeCol()

ReverseAddressGeocoder Synapse.ML.Geospatial.ReverseAddressGeocoder.SetLongitudeCol ( string  value)

Sets value for longitude column

Parameters
valuethe longitude of location
Returns
New ReverseAddressGeocoder object

◆ SetMaxPollingRetries()

ReverseAddressGeocoder Synapse.ML.Geospatial.ReverseAddressGeocoder.SetMaxPollingRetries ( int  value)

Sets value for maxPollingRetries

Parameters
valuenumber of times to poll
Returns
New ReverseAddressGeocoder object

◆ SetOutputCol()

ReverseAddressGeocoder Synapse.ML.Geospatial.ReverseAddressGeocoder.SetOutputCol ( string  value)

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New ReverseAddressGeocoder object

◆ SetPollingDelay()

ReverseAddressGeocoder Synapse.ML.Geospatial.ReverseAddressGeocoder.SetPollingDelay ( int  value)

Sets value for pollingDelay

Parameters
valuenumber of milliseconds to wait between polling
Returns
New ReverseAddressGeocoder object

◆ SetSubscriptionKey()

ReverseAddressGeocoder Synapse.ML.Geospatial.ReverseAddressGeocoder.SetSubscriptionKey ( string  value)

Sets value for subscriptionKey

Parameters
valuethe API key to use
Returns
New ReverseAddressGeocoder object

◆ SetSubscriptionKeyCol()

ReverseAddressGeocoder Synapse.ML.Geospatial.ReverseAddressGeocoder.SetSubscriptionKeyCol ( string  value)

Sets value for subscriptionKey column

Parameters
valuethe API key to use
Returns
New ReverseAddressGeocoder object

◆ SetSuppressMaxRetriesExceededException()

ReverseAddressGeocoder Synapse.ML.Geospatial.ReverseAddressGeocoder.SetSuppressMaxRetriesExceededException ( bool  value)

Sets value for suppressMaxRetriesExceededException

Parameters
valueset true to suppress the maxumimum retries exception and report in the error column
Returns
New ReverseAddressGeocoder object

◆ SetTimeout()

ReverseAddressGeocoder Synapse.ML.Geospatial.ReverseAddressGeocoder.SetTimeout ( double  value)

Sets value for timeout

Parameters
valuenumber of seconds to wait before closing the connection
Returns
New ReverseAddressGeocoder object

◆ SetUrl()

ReverseAddressGeocoder Synapse.ML.Geospatial.ReverseAddressGeocoder.SetUrl ( string  value)

Sets value for url

Parameters
valueUrl of the service
Returns
New ReverseAddressGeocoder object

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