AddressGeocoder implements AddressGeocoder More...

Inheritance diagram for Synapse.ML.Geospatial.AddressGeocoder:

Collaboration diagram for Synapse.ML.Geospatial.AddressGeocoder:

Public Member Functions
	AddressGeocoder ()
	Creates a AddressGeocoder without any parameters. More...

	AddressGeocoder (string uid)
	Creates a AddressGeocoder with a UID that is used to give the AddressGeocoder a unique ID. More...

AddressGeocoder	SetAddress (string[] value)
	Sets value for address More...

AddressGeocoder	SetAddressCol (string value)
	Sets value for address column More...

AddressGeocoder	SetBackoffs (int[] value)
	Sets value for backoffs More...

AddressGeocoder	SetConcurrency (int value)
	Sets value for concurrency More...

AddressGeocoder	SetConcurrentTimeout (double value)
	Sets value for concurrentTimeout More...

AddressGeocoder	SetErrorCol (string value)
	Sets value for errorCol More...

AddressGeocoder	SetInitialPollingDelay (int value)
	Sets value for initialPollingDelay More...

AddressGeocoder	SetMaxPollingRetries (int value)
	Sets value for maxPollingRetries More...

AddressGeocoder	SetOutputCol (string value)
	Sets value for outputCol More...

AddressGeocoder	SetPollingDelay (int value)
	Sets value for pollingDelay More...

AddressGeocoder	SetSubscriptionKey (string value)
	Sets value for subscriptionKey More...

AddressGeocoder	SetSubscriptionKeyCol (string value)
	Sets value for subscriptionKey column More...

AddressGeocoder	SetSuppressMaxRetriesExceededException (bool value)
	Sets value for suppressMaxRetriesExceededException More...

AddressGeocoder	SetTimeout (double value)
	Sets value for timeout More...

AddressGeocoder	SetUrl (string value)
	Sets value for url More...

string []	GetAddress ()
	Gets address value 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...

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< AddressGeocoder >	Read ()
	Get the corresponding JavaMLReader instance. More...

Static Public Member Functions
static AddressGeocoder	Load (string path)
	Loads the AddressGeocoder that was previously saved using Save(string). More...

Detailed Description

AddressGeocoder implements AddressGeocoder

Constructor & Destructor Documentation

◆ AddressGeocoder() [1/2]

Synapse.ML.Geospatial.AddressGeocoder.AddressGeocoder ( )

inline

Creates a AddressGeocoder without any parameters.

◆ AddressGeocoder() [2/2]

Synapse.ML.Geospatial.AddressGeocoder.AddressGeocoder ( string uid )

inline

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

Parameters

uid	An immutable unique ID for the object and its derivatives.

Member Function Documentation

◆ GetAddress()

string [] Synapse.ML.Geospatial.AddressGeocoder.GetAddress ( )

Gets address value

Returns: address: the address to geocode

◆ GetBackoffs()

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

Gets backoffs value

Returns: backoffs: array of backoffs to use in the handler

◆ GetConcurrency()

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

Gets concurrency value

Returns: concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

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

Gets concurrentTimeout value

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

◆ GetErrorCol()

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

Gets errorCol value

Returns: errorCol: column to hold http errors

◆ GetInitialPollingDelay()

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

Gets initialPollingDelay value

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

◆ GetMaxPollingRetries()

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

Gets maxPollingRetries value

Returns: maxPollingRetries: number of times to poll

◆ GetOutputCol()

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

Gets outputCol value

Returns: outputCol: The name of the output column

◆ GetPollingDelay()

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

Gets pollingDelay value

Returns: pollingDelay: number of milliseconds to wait between polling

◆ GetSubscriptionKey()

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

Gets subscriptionKey value

Returns: subscriptionKey: the API key to use

◆ GetSuppressMaxRetriesExceededException()

bool Synapse.ML.Geospatial.AddressGeocoder.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.AddressGeocoder.GetTimeout ( )

Gets timeout value

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

◆ GetUrl()

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

Gets url value

Returns: url: Url of the service

◆ Load()

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

static

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

Parameters

path	The path the previous AddressGeocoder was saved to

Returns: New AddressGeocoder object, loaded from path.

◆ Read()

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

Get the corresponding JavaMLReader instance.

Returns: an JavaMLReader<AddressGeocoder> instance for this ML instance.

◆ Save()

void Synapse.ML.Geospatial.AddressGeocoder.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

path	The path to save the object to

◆ SetAddress()

AddressGeocoder Synapse.ML.Geospatial.AddressGeocoder.SetAddress ( string [] value )

Sets value for address

Parameters

value the address to geocode

Returns: New AddressGeocoder object

◆ SetAddressCol()

AddressGeocoder Synapse.ML.Geospatial.AddressGeocoder.SetAddressCol ( string value )

Sets value for address column

Parameters

value the address to geocode

Returns: New AddressGeocoder object

◆ SetBackoffs()

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

Sets value for backoffs

Parameters

value array of backoffs to use in the handler

Returns: New AddressGeocoder object

◆ SetConcurrency()

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

Sets value for concurrency

Parameters

value max number of concurrent calls

Returns: New AddressGeocoder object

◆ SetConcurrentTimeout()

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

Sets value for concurrentTimeout

Parameters

value max number seconds to wait on futures if concurrency >= 1

Returns: New AddressGeocoder object

◆ SetErrorCol()

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

Sets value for errorCol

Parameters

value column to hold http errors

Returns: New AddressGeocoder object

◆ SetInitialPollingDelay()

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

Sets value for initialPollingDelay

Parameters

value number of milliseconds to wait before first poll for result

Returns: New AddressGeocoder object

◆ SetMaxPollingRetries()

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

Sets value for maxPollingRetries

Parameters

value number of times to poll

Returns: New AddressGeocoder object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters

value The name of the output column

Returns: New AddressGeocoder object

◆ SetPollingDelay()

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

Sets value for pollingDelay

Parameters

value number of milliseconds to wait between polling

Returns: New AddressGeocoder object

◆ SetSubscriptionKey()

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

Sets value for subscriptionKey

Parameters

value the API key to use

Returns: New AddressGeocoder object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters

value the API key to use

Returns: New AddressGeocoder object

◆ SetSuppressMaxRetriesExceededException()

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

Sets value for suppressMaxRetriesExceededException

Parameters

value set true to suppress the maxumimum retries exception and report in the error column

Returns: New AddressGeocoder object

◆ SetTimeout()

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

Sets value for timeout

Parameters

value number of seconds to wait before closing the connection

Returns: New AddressGeocoder object

◆ SetUrl()

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

Sets value for url

Parameters

value Url of the service

Returns: New AddressGeocoder object

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

synapse/ml/geospatial/AddressGeocoder.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AddressGeocoder() [1/2]

◆ AddressGeocoder() [2/2]

Member Function Documentation

◆ GetAddress()

◆ GetBackoffs()

◆ GetConcurrency()

◆ GetConcurrentTimeout()

◆ GetErrorCol()

◆ GetInitialPollingDelay()

◆ GetMaxPollingRetries()

◆ GetOutputCol()

◆ GetPollingDelay()

◆ GetSubscriptionKey()

◆ GetSuppressMaxRetriesExceededException()

◆ GetTimeout()

◆ GetUrl()

◆ Load()

◆ Read()

◆ Save()

◆ SetAddress()

◆ SetAddressCol()

◆ SetBackoffs()

◆ SetConcurrency()

◆ SetConcurrentTimeout()

◆ SetErrorCol()

◆ SetInitialPollingDelay()

◆ SetMaxPollingRetries()

◆ SetOutputCol()

◆ SetPollingDelay()

◆ SetSubscriptionKey()

◆ SetSubscriptionKeyCol()

◆ SetSuppressMaxRetriesExceededException()

◆ SetTimeout()

◆ SetUrl()