Synapseml  0.10.2
Public Member Functions | Static Public Member Functions | List of all members
Synapse.ML.Cognitive.DetectMultivariateAnomaly Class Reference

DetectMultivariateAnomaly implements DetectMultivariateAnomaly More...

Inheritance diagram for Synapse.ML.Cognitive.DetectMultivariateAnomaly:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Cognitive.DetectMultivariateAnomaly:
Collaboration graph
[legend]

Public Member Functions

 DetectMultivariateAnomaly ()
 Creates a DetectMultivariateAnomaly without any parameters. More...
 
 DetectMultivariateAnomaly (string uid)
 Creates a DetectMultivariateAnomaly with a UID that is used to give the DetectMultivariateAnomaly a unique ID. More...
 
DetectMultivariateAnomaly SetBackoffs (int[] value)
 Sets value for backoffs More...
 
DetectMultivariateAnomaly SetDiagnosticsInfo (object value)
 Sets value for diagnosticsInfo More...
 
DetectMultivariateAnomaly SetEndTime (string value)
 Sets value for endTime More...
 
DetectMultivariateAnomaly SetErrorCol (string value)
 Sets value for errorCol More...
 
DetectMultivariateAnomaly SetInitialPollingDelay (int value)
 Sets value for initialPollingDelay More...
 
DetectMultivariateAnomaly SetInputCols (string[] value)
 Sets value for inputCols More...
 
DetectMultivariateAnomaly SetIntermediateSaveDir (string value)
 Sets value for intermediateSaveDir More...
 
DetectMultivariateAnomaly SetMaxPollingRetries (int value)
 Sets value for maxPollingRetries More...
 
DetectMultivariateAnomaly SetModelId (string value)
 Sets value for modelId More...
 
DetectMultivariateAnomaly SetOutputCol (string value)
 Sets value for outputCol More...
 
DetectMultivariateAnomaly SetPollingDelay (int value)
 Sets value for pollingDelay More...
 
DetectMultivariateAnomaly SetStartTime (string value)
 Sets value for startTime More...
 
DetectMultivariateAnomaly SetSubscriptionKey (string value)
 Sets value for subscriptionKey More...
 
DetectMultivariateAnomaly SetSubscriptionKeyCol (string value)
 Sets value for subscriptionKey column More...
 
DetectMultivariateAnomaly SetSuppressMaxRetriesException (bool value)
 Sets value for suppressMaxRetriesException More...
 
DetectMultivariateAnomaly SetTimestampCol (string value)
 Sets value for timestampCol More...
 
DetectMultivariateAnomaly SetUrl (string value)
 Sets value for url More...
 
int[] GetBackoffs ()
 Gets backoffs value More...
 
object GetDiagnosticsInfo ()
 Gets diagnosticsInfo value More...
 
string GetEndTime ()
 Gets endTime value More...
 
string GetErrorCol ()
 Gets errorCol value More...
 
int GetInitialPollingDelay ()
 Gets initialPollingDelay value More...
 
string[] GetInputCols ()
 Gets inputCols value More...
 
string GetIntermediateSaveDir ()
 Gets intermediateSaveDir value More...
 
int GetMaxPollingRetries ()
 Gets maxPollingRetries value More...
 
string GetModelId ()
 Gets modelId value More...
 
string GetOutputCol ()
 Gets outputCol value More...
 
int GetPollingDelay ()
 Gets pollingDelay value More...
 
string GetStartTime ()
 Gets startTime value More...
 
string GetSubscriptionKey ()
 Gets subscriptionKey value More...
 
bool GetSuppressMaxRetriesException ()
 Gets suppressMaxRetriesException value More...
 
string GetTimestampCol ()
 Gets timestampCol 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< DetectMultivariateAnomalyRead ()
 Get the corresponding JavaMLReader instance. More...
 
DetectMultivariateAnomaly SetLocation (string value)
 Sets value for location More...
 

Static Public Member Functions

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

Detailed Description

DetectMultivariateAnomaly implements DetectMultivariateAnomaly

Constructor & Destructor Documentation

◆ DetectMultivariateAnomaly() [1/2]

Synapse.ML.Cognitive.DetectMultivariateAnomaly.DetectMultivariateAnomaly ( )
inline

Creates a DetectMultivariateAnomaly without any parameters.

◆ DetectMultivariateAnomaly() [2/2]

Synapse.ML.Cognitive.DetectMultivariateAnomaly.DetectMultivariateAnomaly ( string  uid)
inline

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

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

Member Function Documentation

◆ GetBackoffs()

int [] Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetBackoffs ( )

Gets backoffs value

Returns
backoffs: array of backoffs to use in the handler

◆ GetDiagnosticsInfo()

object Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetDiagnosticsInfo ( )

Gets diagnosticsInfo value

Returns
diagnosticsInfo: diagnosticsInfo for training a multivariate anomaly detection model

◆ GetEndTime()

string Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetEndTime ( )

Gets endTime value

Returns
endTime: A required field, end time of data to be used for detection/generating multivariate anomaly detection model, should be date-time.

◆ GetErrorCol()

string Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetErrorCol ( )

Gets errorCol value

Returns
errorCol: column to hold http errors

◆ GetInitialPollingDelay()

int Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetInitialPollingDelay ( )

Gets initialPollingDelay value

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

◆ GetInputCols()

string [] Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetInputCols ( )

Gets inputCols value

Returns
inputCols: The names of the input columns

◆ GetIntermediateSaveDir()

string Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetIntermediateSaveDir ( )

Gets intermediateSaveDir value

Returns
intermediateSaveDir: Blob storage location in HDFS where intermediate data is saved while training.

◆ GetMaxPollingRetries()

int Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetMaxPollingRetries ( )

Gets maxPollingRetries value

Returns
maxPollingRetries: number of times to poll

◆ GetModelId()

string Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetModelId ( )

Gets modelId value

Returns
modelId: Format - uuid. Model identifier.

◆ GetOutputCol()

string Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetOutputCol ( )

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetPollingDelay()

int Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetPollingDelay ( )

Gets pollingDelay value

Returns
pollingDelay: number of milliseconds to wait between polling

◆ GetStartTime()

string Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetStartTime ( )

Gets startTime value

Returns
startTime: A required field, start time of data to be used for detection/generating multivariate anomaly detection model, should be date-time.

◆ GetSubscriptionKey()

string Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns
subscriptionKey: the API key to use

◆ GetSuppressMaxRetriesException()

bool Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetSuppressMaxRetriesException ( )

Gets suppressMaxRetriesException value

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

◆ GetTimestampCol()

string Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetTimestampCol ( )

Gets timestampCol value

Returns
timestampCol: Timestamp column name

◆ GetUrl()

string Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetUrl ( )

Gets url value

Returns
url: Url of the service

◆ Load()

static DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.Load ( string  path)
static

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

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

◆ Read()

JavaMLReader<DetectMultivariateAnomaly> Synapse.ML.Cognitive.DetectMultivariateAnomaly.Read ( )

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Cognitive.DetectMultivariateAnomaly.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()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetBackoffs ( int[]  value)

Sets value for backoffs

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

◆ SetDiagnosticsInfo()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetDiagnosticsInfo ( object  value)

Sets value for diagnosticsInfo

Parameters
valuediagnosticsInfo for training a multivariate anomaly detection model
Returns
New DetectMultivariateAnomaly object

◆ SetEndTime()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetEndTime ( string  value)

Sets value for endTime

Parameters
valueA required field, end time of data to be used for detection/generating multivariate anomaly detection model, should be date-time.
Returns
New DetectMultivariateAnomaly object

◆ SetErrorCol()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetErrorCol ( string  value)

Sets value for errorCol

Parameters
valuecolumn to hold http errors
Returns
New DetectMultivariateAnomaly object

◆ SetInitialPollingDelay()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetInitialPollingDelay ( int  value)

Sets value for initialPollingDelay

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

◆ SetInputCols()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetInputCols ( string[]  value)

Sets value for inputCols

Parameters
valueThe names of the input columns
Returns
New DetectMultivariateAnomaly object

◆ SetIntermediateSaveDir()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetIntermediateSaveDir ( string  value)

Sets value for intermediateSaveDir

Parameters
valueBlob storage location in HDFS where intermediate data is saved while training.
Returns
New DetectMultivariateAnomaly object

◆ SetLocation()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetLocation ( string  value)

Sets value for location

Parameters
valueLocation of the cognitive service
Returns
New DetectMultivariateAnomaly object

◆ SetMaxPollingRetries()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetMaxPollingRetries ( int  value)

Sets value for maxPollingRetries

Parameters
valuenumber of times to poll
Returns
New DetectMultivariateAnomaly object

◆ SetModelId()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetModelId ( string  value)

Sets value for modelId

Parameters
valueFormat - uuid. Model identifier.
Returns
New DetectMultivariateAnomaly object

◆ SetOutputCol()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetOutputCol ( string  value)

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New DetectMultivariateAnomaly object

◆ SetPollingDelay()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetPollingDelay ( int  value)

Sets value for pollingDelay

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

◆ SetStartTime()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetStartTime ( string  value)

Sets value for startTime

Parameters
valueA required field, start time of data to be used for detection/generating multivariate anomaly detection model, should be date-time.
Returns
New DetectMultivariateAnomaly object

◆ SetSubscriptionKey()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetSubscriptionKey ( string  value)

Sets value for subscriptionKey

Parameters
valuethe API key to use
Returns
New DetectMultivariateAnomaly object

◆ SetSubscriptionKeyCol()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetSubscriptionKeyCol ( string  value)

Sets value for subscriptionKey column

Parameters
valuethe API key to use
Returns
New DetectMultivariateAnomaly object

◆ SetSuppressMaxRetriesException()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetSuppressMaxRetriesException ( bool  value)

Sets value for suppressMaxRetriesException

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

◆ SetTimestampCol()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetTimestampCol ( string  value)

Sets value for timestampCol

Parameters
valueTimestamp column name
Returns
New DetectMultivariateAnomaly object

◆ SetUrl()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetUrl ( string  value)

Sets value for url

Parameters
valueUrl of the service
Returns
New DetectMultivariateAnomaly object

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