Synapse.ML.Cognitive.DetectMultivariateAnomaly Class Reference

DetectMultivariateAnomaly implements DetectMultivariateAnomaly More...

Inheritance diagram for Synapse.ML.Cognitive.DetectMultivariateAnomaly:

Collaboration diagram for Synapse.ML.Cognitive.DetectMultivariateAnomaly:

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	SetConnectionString (string value)
	Sets value for connectionString More...
DetectMultivariateAnomaly	SetContainerName (string value)
	Sets value for containerName More...
DetectMultivariateAnomaly	SetEndTime (string value)
	Sets value for endTime More...
DetectMultivariateAnomaly	SetEndpoint (string value)
	Sets value for endpoint 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	SetSasToken (string value)
	Sets value for sasToken More...
DetectMultivariateAnomaly	SetStartTime (string value)
	Sets value for startTime More...
DetectMultivariateAnomaly	SetStorageKey (string value)
	Sets value for storageKey More...
DetectMultivariateAnomaly	SetStorageName (string value)
	Sets value for storageName More...
DetectMultivariateAnomaly	SetSubscriptionKey (string value)
	Sets value for subscriptionKey More...
DetectMultivariateAnomaly	SetSubscriptionKeyCol (string value)
	Sets value for subscriptionKey column More...
DetectMultivariateAnomaly	SetSuppressMaxRetriesExceededException (bool value)
	Sets value for suppressMaxRetriesExceededException 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...
string	GetConnectionString ()
	Gets connectionString value More...
string	GetContainerName ()
	Gets containerName value More...
string	GetEndTime ()
	Gets endTime value More...
string	GetEndpoint ()
	Gets endpoint 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	GetSasToken ()
	Gets sasToken value More...
string	GetStartTime ()
	Gets startTime value More...
string	GetStorageKey ()
	Gets storageKey value More...
string	GetStorageName ()
	Gets storageName value More...
string	GetSubscriptionKey ()
	Gets subscriptionKey value More...
bool	GetSuppressMaxRetriesExceededException ()
	Gets suppressMaxRetriesExceededException 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< DetectMultivariateAnomaly >	Read ()
	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

uid	An 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

GetConnectionString()

string Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetConnectionString

(

)

Gets connectionString value

Returns

connectionString: Connection String for your storage account used for uploading files.

GetContainerName()

string Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetContainerName

(

)

Gets containerName value

Returns

containerName: Container that will be used to upload files to.

GetEndpoint()

string Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetEndpoint

(

)

Gets endpoint value

Returns

endpoint: End Point for your storage account used for uploading files.

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: Directory name of which you want to save the intermediate data produced 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

GetSasToken()

string Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetSasToken

(

)

Gets sasToken value

Returns

sasToken: SAS Token for your storage account used for uploading files.

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.

GetStorageKey()

string Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetStorageKey

(

)

Gets storageKey value

Returns

storageKey: Storage Key for your storage account used for uploading files.

GetStorageName()

string Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetStorageName

(

)

Gets storageName value

Returns

storageName: Storage Name for your storage account used for uploading files.

GetSubscriptionKey()

string Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetSubscriptionKey

(

)

Gets subscriptionKey value

Returns

subscriptionKey: the API key to use

GetSuppressMaxRetriesExceededException()

bool Synapse.ML.Cognitive.DetectMultivariateAnomaly.GetSuppressMaxRetriesExceededException

(

)

Gets suppressMaxRetriesExceededException value

Returns

suppressMaxRetriesExceededException: 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

path	The 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

path	The path to save the object to

SetBackoffs()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetBackoffs

(

int []

value

)

Sets value for backoffs

Parameters

value

array of backoffs to use in the handler

Returns

New DetectMultivariateAnomaly object

SetConnectionString()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetConnectionString

(

string

value

)

Sets value for connectionString

Parameters

value

Connection String for your storage account used for uploading files.

Returns

New DetectMultivariateAnomaly object

SetContainerName()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetContainerName

(

string

value

)

Sets value for containerName

Parameters

value

Container that will be used to upload files to.

Returns

New DetectMultivariateAnomaly object

SetEndpoint()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetEndpoint

(

string

value

)

Sets value for endpoint

Parameters

value

End Point for your storage account used for uploading files.

Returns

New DetectMultivariateAnomaly object

SetEndTime()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.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 DetectMultivariateAnomaly object

SetErrorCol()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetErrorCol

(

string

value

)

Sets value for errorCol

Parameters

value

column to hold http errors

Returns

New DetectMultivariateAnomaly object

SetInitialPollingDelay()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetInitialPollingDelay

(

int

value

)

Sets value for initialPollingDelay

Parameters

value

number 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

value

The names of the input columns

Returns

New DetectMultivariateAnomaly object

SetIntermediateSaveDir()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetIntermediateSaveDir

(

string

value

)

Sets value for intermediateSaveDir

Parameters

value

Directory name of which you want to save the intermediate data produced while training.

Returns

New DetectMultivariateAnomaly object

SetLocation()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetLocation

(

string

value

)

Sets value for location

Parameters

value

Location of the cognitive service

Returns

New DetectMultivariateAnomaly object

SetMaxPollingRetries()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetMaxPollingRetries

(

int

value

)

Sets value for maxPollingRetries

Parameters

value

number of times to poll

Returns

New DetectMultivariateAnomaly object

SetModelId()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetModelId

(

string

value

)

Sets value for modelId

Parameters

value

Format - uuid. Model identifier.

Returns

New DetectMultivariateAnomaly object

SetOutputCol()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

The name of the output column

Returns

New DetectMultivariateAnomaly object

SetPollingDelay()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetPollingDelay

(

int

value

)

Sets value for pollingDelay

Parameters

value

number of milliseconds to wait between polling

Returns

New DetectMultivariateAnomaly object

SetSasToken()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetSasToken

(

string

value

)

Sets value for sasToken

Parameters

value

SAS Token for your storage account used for uploading files.

Returns

New DetectMultivariateAnomaly object

SetStartTime()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.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 DetectMultivariateAnomaly object

SetStorageKey()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetStorageKey

(

string

value

)

Sets value for storageKey

Parameters

value

Storage Key for your storage account used for uploading files.

Returns

New DetectMultivariateAnomaly object

SetStorageName()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetStorageName

(

string

value

)

Sets value for storageName

Parameters

value

Storage Name for your storage account used for uploading files.

Returns

New DetectMultivariateAnomaly object

SetSubscriptionKey()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetSubscriptionKey

(

string

value

)

Sets value for subscriptionKey

Parameters

value

the API key to use

Returns

New DetectMultivariateAnomaly object

SetSubscriptionKeyCol()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetSubscriptionKeyCol

(

string

value

)

Sets value for subscriptionKey column

Parameters

value

the API key to use

Returns

New DetectMultivariateAnomaly object

SetSuppressMaxRetriesExceededException()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.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 DetectMultivariateAnomaly object

SetTimestampCol()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetTimestampCol

(

string

value

)

Sets value for timestampCol

Parameters

value

Timestamp column name

Returns

New DetectMultivariateAnomaly object

SetUrl()

DetectMultivariateAnomaly Synapse.ML.Cognitive.DetectMultivariateAnomaly.SetUrl

(

string

value

)

Sets value for url

Parameters

value

Url of the service

Returns

New DetectMultivariateAnomaly object

---

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

• synapse/ml/cognitive/DetectMultivariateAnomaly.cs