SimpleDetectMultivariateAnomaly implements SimpleDetectMultivariateAnomaly More...

Inheritance diagram for Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly:

[legend]

Collaboration diagram for Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly:

[legend]

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

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

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

SimpleDetectMultivariateAnomaly	SetDiagnosticsInfo (DiagnosticsInfo value)
	Sets value for diagnosticsInfo More...

SimpleDetectMultivariateAnomaly	SetEndTime (string value)
	Sets value for endTime More...

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

SimpleDetectMultivariateAnomaly	SetHandler (object value)
	Sets value for handler More...

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

SimpleDetectMultivariateAnomaly	SetInputCols (string[] value)
	Sets value for inputCols More...

SimpleDetectMultivariateAnomaly	SetIntermediateSaveDir (string value)
	Sets value for intermediateSaveDir More...

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

SimpleDetectMultivariateAnomaly	SetModelId (string value)
	Sets value for modelId More...

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

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

SimpleDetectMultivariateAnomaly	SetStartTime (string value)
	Sets value for startTime More...

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

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

SimpleDetectMultivariateAnomaly	SetSuppressMaxRetriesException (bool value)
	Sets value for suppressMaxRetriesException More...

SimpleDetectMultivariateAnomaly	SetTimestampCol (string value)
	Sets value for timestampCol More...

SimpleDetectMultivariateAnomaly	SetTopContributorCount (int value)
	Sets value for topContributorCount More...

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

int[]	GetBackoffs ()
	Gets backoffs value More...

DiagnosticsInfo	GetDiagnosticsInfo ()
	Gets diagnosticsInfo value More...

string	GetEndTime ()
	Gets endTime value More...

string	GetErrorCol ()
	Gets errorCol value More...

object	GetHandler ()
	Gets handler 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...

int	GetTopContributorCount ()
	Gets topContributorCount 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< SimpleDetectMultivariateAnomaly >	Read ()
	Get the corresponding JavaMLReader instance. More...

SimpleDetectMultivariateAnomaly	SetLocation (string value)
	Sets value for location More...

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

Detailed Description

SimpleDetectMultivariateAnomaly implements SimpleDetectMultivariateAnomaly

Constructor & Destructor Documentation

◆ SimpleDetectMultivariateAnomaly() [1/2]

Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.SimpleDetectMultivariateAnomaly ( )

inline

Creates a SimpleDetectMultivariateAnomaly without any parameters.

◆ SimpleDetectMultivariateAnomaly() [2/2]

Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.SimpleDetectMultivariateAnomaly ( string uid )

inline

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

Parameters

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

Member Function Documentation

◆ GetBackoffs()

int [] Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.GetBackoffs ( )

Gets backoffs value

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

◆ GetDiagnosticsInfo()

DiagnosticsInfo Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.GetDiagnosticsInfo ( )

inline

Gets diagnosticsInfo value

Returns: diagnosticsInfo: diagnosticsInfo for training a multivariate anomaly detection model

◆ GetEndTime()

string Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.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.Services.Anomaly.SimpleDetectMultivariateAnomaly.GetErrorCol ( )

Gets errorCol value

Returns: errorCol: column to hold http errors

◆ GetHandler()

object Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.GetHandler ( )

Gets handler value

Returns: handler: Which strategy to use when handling requests

◆ GetInitialPollingDelay()

int Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.GetInitialPollingDelay ( )

Gets initialPollingDelay value

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

◆ GetInputCols()

string [] Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.GetInputCols ( )

Gets inputCols value

Returns: inputCols: The names of the input columns

◆ GetIntermediateSaveDir()

string Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.GetIntermediateSaveDir ( )

Gets intermediateSaveDir value

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

◆ GetMaxPollingRetries()

int Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.GetMaxPollingRetries ( )

Gets maxPollingRetries value

Returns: maxPollingRetries: number of times to poll

◆ GetModelId()

string Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.GetModelId ( )

Gets modelId value

Returns: modelId: Format - uuid. Model identifier.

◆ GetOutputCol()

string Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.GetOutputCol ( )

Gets outputCol value

Returns: outputCol: The name of the output column

◆ GetPollingDelay()

int Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.GetPollingDelay ( )

Gets pollingDelay value

Returns: pollingDelay: number of milliseconds to wait between polling

◆ GetStartTime()

string Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.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.Services.Anomaly.SimpleDetectMultivariateAnomaly.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns: subscriptionKey: the API key to use

◆ GetSuppressMaxRetriesException()

bool Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.GetSuppressMaxRetriesException ( )

Gets suppressMaxRetriesException value

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

◆ GetTimestampCol()

string Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.GetTimestampCol ( )

Gets timestampCol value

Returns: timestampCol: Timestamp column name

◆ GetTopContributorCount()

int Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.GetTopContributorCount ( )

Gets topContributorCount value

Returns: topContributorCount: This is a number that you could specify N from 1 to 30, which will give you the details of top N contributed variables in the anomaly results. For example, if you have 100 variables in the model, but you only care the top five contributed variables in detection results, then you should fill this field with 5. The default number is 10.

◆ GetUrl()

string Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.GetUrl ( )

Gets url value

Returns: url: Url of the service

◆ Load()

static SimpleDetectMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.Load ( string path )

static

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

Parameters

path	The path the previous SimpleDetectMultivariateAnomaly was saved to

Returns: New SimpleDetectMultivariateAnomaly object, loaded from path.

◆ Read()

JavaMLReader<SimpleDetectMultivariateAnomaly> Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.Read ( )

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

◆ SetBackoffs()

SimpleDetectMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.SetBackoffs ( int[] value )

Sets value for backoffs

Parameters

value array of backoffs to use in the handler

Returns: New SimpleDetectMultivariateAnomaly object

◆ SetDiagnosticsInfo()

SimpleDetectMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.SetDiagnosticsInfo ( DiagnosticsInfo value )

Sets value for diagnosticsInfo

Parameters

value diagnosticsInfo for training a multivariate anomaly detection model

Returns: New SimpleDetectMultivariateAnomaly object

◆ SetEndTime()

SimpleDetectMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.SetEndTime ( string value )

Sets value for endTime

Parameters

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

Returns: New SimpleDetectMultivariateAnomaly object

◆ SetErrorCol()

SimpleDetectMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.SetErrorCol ( string value )

Sets value for errorCol

Parameters

value column to hold http errors

Returns: New SimpleDetectMultivariateAnomaly object

◆ SetHandler()

SimpleDetectMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.SetHandler ( object value )

Sets value for handler

Parameters

value Which strategy to use when handling requests

Returns: New SimpleDetectMultivariateAnomaly object

◆ SetInitialPollingDelay()

SimpleDetectMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.SetInitialPollingDelay ( int value )

Sets value for initialPollingDelay

Parameters

value number of milliseconds to wait before first poll for result

Returns: New SimpleDetectMultivariateAnomaly object

◆ SetInputCols()

SimpleDetectMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.SetInputCols ( string[] value )

Sets value for inputCols

Parameters

value The names of the input columns

Returns: New SimpleDetectMultivariateAnomaly object

◆ SetIntermediateSaveDir()

SimpleDetectMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.SetIntermediateSaveDir ( string value )

Sets value for intermediateSaveDir

Parameters

value Blob storage location in HDFS where intermediate data is saved while training.

Returns: New SimpleDetectMultivariateAnomaly object

◆ SetLocation()

SimpleDetectMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.SetLocation ( string value )

Sets value for location

Parameters

value Location of the cognitive service

Returns: New SimpleDetectMultivariateAnomaly object

◆ SetMaxPollingRetries()

SimpleDetectMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.SetMaxPollingRetries ( int value )

Sets value for maxPollingRetries

Parameters

value number of times to poll

Returns: New SimpleDetectMultivariateAnomaly object

◆ SetModelId()

SimpleDetectMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.SetModelId ( string value )

Sets value for modelId

Parameters

value Format - uuid. Model identifier.

Returns: New SimpleDetectMultivariateAnomaly object

◆ SetOutputCol()

SimpleDetectMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.SetOutputCol ( string value )

Sets value for outputCol

Parameters

value The name of the output column

Returns: New SimpleDetectMultivariateAnomaly object

◆ SetPollingDelay()

SimpleDetectMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.SetPollingDelay ( int value )

Sets value for pollingDelay

Parameters

value number of milliseconds to wait between polling

Returns: New SimpleDetectMultivariateAnomaly object

◆ SetStartTime()

SimpleDetectMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.SetStartTime ( string value )

Sets value for startTime

Parameters

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

Returns: New SimpleDetectMultivariateAnomaly object

◆ SetSubscriptionKey()

SimpleDetectMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.SetSubscriptionKey ( string value )

Sets value for subscriptionKey

Parameters

value the API key to use

Returns: New SimpleDetectMultivariateAnomaly object

◆ SetSubscriptionKeyCol()

SimpleDetectMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.SetSubscriptionKeyCol ( string value )

Sets value for subscriptionKey column

Parameters

value the API key to use

Returns: New SimpleDetectMultivariateAnomaly object

◆ SetSuppressMaxRetriesException()

SimpleDetectMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.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 SimpleDetectMultivariateAnomaly object

◆ SetTimestampCol()

SimpleDetectMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.SetTimestampCol ( string value )

Sets value for timestampCol

Parameters

value Timestamp column name

Returns: New SimpleDetectMultivariateAnomaly object

◆ SetTopContributorCount()

SimpleDetectMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.SetTopContributorCount ( int value )

Sets value for topContributorCount

Parameters

value This is a number that you could specify N from 1 to 30, which will give you the details of top N contributed variables in the anomaly results. For example, if you have 100 variables in the model, but you only care the top five contributed variables in detection results, then you should fill this field with 5. The default number is 10.

Returns: New SimpleDetectMultivariateAnomaly object

◆ SetUrl()

SimpleDetectMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleDetectMultivariateAnomaly.SetUrl ( string value )

Sets value for url

Parameters

value Url of the service

Returns: New SimpleDetectMultivariateAnomaly object

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

synapse/ml/services/anomaly/SimpleDetectMultivariateAnomaly.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SimpleDetectMultivariateAnomaly() [1/2]

◆ SimpleDetectMultivariateAnomaly() [2/2]

Member Function Documentation

◆ GetBackoffs()

◆ GetDiagnosticsInfo()

◆ GetEndTime()

◆ GetErrorCol()

◆ GetHandler()

◆ GetInitialPollingDelay()

◆ GetInputCols()

◆ GetIntermediateSaveDir()

◆ GetMaxPollingRetries()

◆ GetModelId()

◆ GetOutputCol()

◆ GetPollingDelay()

◆ GetStartTime()

◆ GetSubscriptionKey()

◆ GetSuppressMaxRetriesException()

◆ GetTimestampCol()

◆ GetTopContributorCount()

◆ GetUrl()

◆ Load()

◆ Read()

◆ Save()

◆ SetBackoffs()

◆ SetDiagnosticsInfo()

◆ SetEndTime()

◆ SetErrorCol()

◆ SetHandler()

◆ SetInitialPollingDelay()

◆ SetInputCols()

◆ SetIntermediateSaveDir()

◆ SetLocation()

◆ SetMaxPollingRetries()

◆ SetModelId()

◆ SetOutputCol()

◆ SetPollingDelay()

◆ SetStartTime()

◆ SetSubscriptionKey()

◆ SetSubscriptionKeyCol()

◆ SetSuppressMaxRetriesException()

◆ SetTimestampCol()

◆ SetTopContributorCount()

◆ SetUrl()