Synapse.ML.Services.Geospatial.ReverseAddressGeocoder Class Reference

ReverseAddressGeocoder implements ReverseAddressGeocoder More...

Inheritance diagram for Synapse.ML.Services.Geospatial.ReverseAddressGeocoder:

Collaboration diagram for Synapse.ML.Services.Geospatial.ReverseAddressGeocoder:

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	SetAADToken (string value)
	Sets value for AADToken More...
ReverseAddressGeocoder	SetAADTokenCol (string value)
	Sets value for AADToken column 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	SetSuppressMaxRetriesException (bool value)
	Sets value for suppressMaxRetriesException More...
ReverseAddressGeocoder	SetTimeout (double value)
	Sets value for timeout More...
ReverseAddressGeocoder	SetUrl (string value)
	Sets value for url More...
string	GetAADToken ()
	Gets AADToken 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...
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	GetSuppressMaxRetriesException ()
	Gets suppressMaxRetriesException 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< ReverseAddressGeocoder >	Read ()
	Get the corresponding JavaMLReader instance. More...
ReverseAddressGeocoder	SetCustomServiceName (string value)
	Sets value for service name More...
ReverseAddressGeocoder	SetEndpoint (string value)
	Sets value for endpoint 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.Services.Geospatial.ReverseAddressGeocoder.ReverseAddressGeocoder ( )

inline

Creates a ReverseAddressGeocoder without any parameters.

ReverseAddressGeocoder() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

GetAADToken()

string Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.GetAADToken

(

)

Gets AADToken value

Returns

AADToken: AAD Token used for authentication

GetBackoffs()

int [] Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.GetBackoffs

(

)

Gets backoffs value

Returns

backoffs: array of backoffs to use in the handler

GetConcurrency()

int Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.GetConcurrency

(

)

Gets concurrency value

Returns

concurrency: max number of concurrent calls

GetConcurrentTimeout()

double Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.GetConcurrentTimeout

(

)

Gets concurrentTimeout value

Returns

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

GetErrorCol()

string Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.GetErrorCol

(

)

Gets errorCol value

Returns

errorCol: column to hold http errors

GetInitialPollingDelay()

int Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.GetInitialPollingDelay

(

)

Gets initialPollingDelay value

Returns

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

GetLatitude()

double [] Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.GetLatitude

(

)

Gets latitude value

Returns

latitude: the latitude of location

GetLongitude()

double [] Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.GetLongitude

(

)

Gets longitude value

Returns

longitude: the longitude of location

GetMaxPollingRetries()

int Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.GetMaxPollingRetries

(

)

Gets maxPollingRetries value

Returns

maxPollingRetries: number of times to poll

GetOutputCol()

string Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: The name of the output column

GetPollingDelay()

int Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.GetPollingDelay

(

)

Gets pollingDelay value

Returns

pollingDelay: number of milliseconds to wait between polling

GetSubscriptionKey()

string Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.GetSubscriptionKey

(

)

Gets subscriptionKey value

Returns

subscriptionKey: the API key to use

GetSuppressMaxRetriesException()

bool Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.GetSuppressMaxRetriesException

(

)

Gets suppressMaxRetriesException value

Returns

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

GetTimeout()

double Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.GetTimeout

(

)

Gets timeout value

Returns

timeout: number of seconds to wait before closing the connection

GetUrl()

string Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.GetUrl

(

)

Gets url value

Returns

url: Url of the service

Load()

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

static

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

Parameters

path	The path the previous ReverseAddressGeocoder was saved to

Returns

New ReverseAddressGeocoder object, loaded from path.

Read()

JavaMLReader<ReverseAddressGeocoder> Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.Read

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<ReverseAddressGeocoder> instance for this ML instance.

Save()

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

path	The path to save the object to

SetAADToken()

ReverseAddressGeocoder Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.SetAADToken

(

string

value

)

Sets value for AADToken

Parameters

value

AAD Token used for authentication

Returns

New ReverseAddressGeocoder object

SetAADTokenCol()

ReverseAddressGeocoder Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.SetAADTokenCol

(

string

value

)

Sets value for AADToken column

Parameters

value

AAD Token used for authentication

Returns

New ReverseAddressGeocoder object

SetBackoffs()

ReverseAddressGeocoder Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.SetBackoffs

(

int[]

value

)

Sets value for backoffs

Parameters

value

array of backoffs to use in the handler

Returns

New ReverseAddressGeocoder object

SetConcurrency()

ReverseAddressGeocoder Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.SetConcurrency

(

int

value

)

Sets value for concurrency

Parameters

value

max number of concurrent calls

Returns

New ReverseAddressGeocoder object

SetConcurrentTimeout()

ReverseAddressGeocoder Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.SetConcurrentTimeout

(

double

value

)

Sets value for concurrentTimeout

Parameters

value

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

Returns

New ReverseAddressGeocoder object

SetCustomServiceName()

ReverseAddressGeocoder Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.SetCustomServiceName

(

string

value

)

Sets value for service name

Parameters

value

Service name of the cognitive service if it's custom domain

Returns

New ReverseAddressGeocoder object

SetEndpoint()

ReverseAddressGeocoder Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.SetEndpoint

(

string

value

)

Sets value for endpoint

Parameters

value

Endpoint of the cognitive service

Returns

New ReverseAddressGeocoder object

SetErrorCol()

ReverseAddressGeocoder Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.SetErrorCol

(

string

value

)

Sets value for errorCol

Parameters

value

column to hold http errors

Returns

New ReverseAddressGeocoder object

SetInitialPollingDelay()

ReverseAddressGeocoder Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.SetInitialPollingDelay

(

int

value

)

Sets value for initialPollingDelay

Parameters

value

number of milliseconds to wait before first poll for result

Returns

New ReverseAddressGeocoder object

SetLatitude()

ReverseAddressGeocoder Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.SetLatitude

(

double[]

value

)

Sets value for latitude

Parameters

value

the latitude of location

Returns

New ReverseAddressGeocoder object

SetLatitudeCol()

ReverseAddressGeocoder Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.SetLatitudeCol

(

string

value

)

Sets value for latitude column

Parameters

value

the latitude of location

Returns

New ReverseAddressGeocoder object

SetLongitude()

ReverseAddressGeocoder Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.SetLongitude

(

double[]

value

)

Sets value for longitude

Parameters

value

the longitude of location

Returns

New ReverseAddressGeocoder object

SetLongitudeCol()

ReverseAddressGeocoder Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.SetLongitudeCol

(

string

value

)

Sets value for longitude column

Parameters

value

the longitude of location

Returns

New ReverseAddressGeocoder object

SetMaxPollingRetries()

ReverseAddressGeocoder Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.SetMaxPollingRetries

(

int

value

)

Sets value for maxPollingRetries

Parameters

value

number of times to poll

Returns

New ReverseAddressGeocoder object

SetOutputCol()

ReverseAddressGeocoder Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

The name of the output column

Returns

New ReverseAddressGeocoder object

SetPollingDelay()

ReverseAddressGeocoder Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.SetPollingDelay

(

int

value

)

Sets value for pollingDelay

Parameters

value

number of milliseconds to wait between polling

Returns

New ReverseAddressGeocoder object

SetSubscriptionKey()

ReverseAddressGeocoder Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.SetSubscriptionKey

(

string

value

)

Sets value for subscriptionKey

Parameters

value

the API key to use

Returns

New ReverseAddressGeocoder object

SetSubscriptionKeyCol()

ReverseAddressGeocoder Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.SetSubscriptionKeyCol

(

string

value

)

Sets value for subscriptionKey column

Parameters

value

the API key to use

Returns

New ReverseAddressGeocoder object

SetSuppressMaxRetriesException()

ReverseAddressGeocoder Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.SetSuppressMaxRetriesException

(

bool

value

)

Sets value for suppressMaxRetriesException

Parameters

value

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

Returns

New ReverseAddressGeocoder object

SetTimeout()

ReverseAddressGeocoder Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.SetTimeout

(

double

value

)

Sets value for timeout

Parameters

value

number of seconds to wait before closing the connection

Returns

New ReverseAddressGeocoder object

SetUrl()

ReverseAddressGeocoder Synapse.ML.Services.Geospatial.ReverseAddressGeocoder.SetUrl

(

string

value

)

Sets value for url

Parameters

value

Url of the service

Returns

New ReverseAddressGeocoder object

---

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

• synapse/ml/services/geospatial/ReverseAddressGeocoder.cs