DataFeedOptions Class

Package:

com.azure.ai.metricsadvisor.administration.models

Maven Artifact:

com.azure:azure-ai-metricsadvisor:1.2.4

• java.lang.Object
• • com.azure.ai.metricsadvisor.administration.models.DataFeedOptions

public final class DataFeedOptions

The DataFeedOptions model.

Constructor Summary

Constructor	Description
DataFeedOptions()	Create a new instance of DataFeedOptions.

Method Summary

Modifier and Type	Method and Description
DataFeedAccessMode	getAccessMode() Get the data feed access mode, default is Private.
String	getActionLinkTemplate() Get the action link for alert.
List<String>	getAdmins() Get the list of data feed administrator emails and clientIds.
String	getDescription() Get the dataFeedDescription property: data feed description.
DataFeedMissingDataPointFillSettings	getMissingDataPointFillSettings() Get the data feed data point fill properties.
DataFeedRollupSettings	getRollupSettings() Get the data feed roll up properties.
List<String>	getViewers() Get the list of data feed viewer emails and clientIds.
DataFeedOptions	setAccessMode(DataFeedAccessMode dataFeedAccessMode) Set the data feed access mode, default is Private.
DataFeedOptions	setActionLinkTemplate(String actionLinkTemplate) Set the action link for alert.
DataFeedOptions	setAdmins(List<String> admins) Set the list of data feed administrator emails and clientIds.
DataFeedOptions	setDescription(String dataFeedDescription) Set the dataFeedDescription property: data feed description.
DataFeedOptions	setMissingDataPointFillSettings(DataFeedMissingDataPointFillSettings dataFeedMissingDataPointFillSettings) Set the data feed, data point fill properties.
DataFeedOptions	setRollupSettings(DataFeedRollupSettings dataFeedRollupSettings) Set the data feed roll up properties.
DataFeedOptions	setViewers(List<String> viewers) Set the list of data feed viewer emails and clientIds.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DataFeedOptions

public DataFeedOptions()

Create a new instance of DataFeedOptions.

Method Details

getAccessMode

public DataFeedAccessMode getAccessMode()

Get the data feed access mode, default is Private.

Returns:

the DataFeedAccessMode value.

getActionLinkTemplate

public String getActionLinkTemplate()

Get the action link for alert.

Returns:

the actionLinkTemplate value.

getAdmins

public List getAdmins()

Get the list of data feed administrator emails and clientIds.

The administrators have total control over the DataFeed, being allowed to update, delete, or pause the DataFeed. Each element in this list represents a user with administrator access, but the value of each string element is either user email address or clientId uniquely identifying the user service principal.

Returns:

a list containing email or clientId of admins

getDescription

public String getDescription()

Get the dataFeedDescription property: data feed description.

Returns:

the dataFeedDescription value.

getMissingDataPointFillSettings

public DataFeedMissingDataPointFillSettings getMissingDataPointFillSettings()

Get the data feed data point fill properties.

Returns:

the data point fill properties.

getRollupSettings

public DataFeedRollupSettings getRollupSettings()

Get the data feed roll up properties.

Returns:

the data feed roll up properties.

getViewers

public List getViewers()

Get the list of data feed viewer emails and clientIds.

The Viewers have read-only access to a DataFeed. Each element in this list represents a user with viewer access, but the value of each string element is either user email address or clientId uniquely identifying the user service principal.

Returns:

a list containing email or clientId of viewers

setAccessMode

public DataFeedOptions setAccessMode(DataFeedAccessMode dataFeedAccessMode)

Set the data feed access mode, default is Private.

Parameters:

dataFeedAccessMode - the value to set.

Returns:

the DataFeedOptions object itself.

setActionLinkTemplate

public DataFeedOptions setActionLinkTemplate(String actionLinkTemplate)

Set the action link for alert.

Parameters:

actionLinkTemplate - the actionLinkTemplate value to set.

Returns:

the DataFeedOptions object itself.

setAdmins

public DataFeedOptions setAdmins(List admins)

Set the list of data feed administrator emails and clientIds.

The administrators have total control over the DataFeed, being allowed to update, delete, or pause the DataFeed. Each element in this list represents a user with administrator access, but the value of each string element is either user email address or clientId uniquely identifying the user service principal.

Parameters:

admins - a list containing email or clientId of admins

Returns:

the DataFeedOptions object itself.

setDescription

public DataFeedOptions setDescription(String dataFeedDescription)

Set the dataFeedDescription property: data feed description.

Parameters:

dataFeedDescription - the dataFeedDescription value to set.

Returns:

the DataFeedOptions object itself.

setMissingDataPointFillSettings

public DataFeedOptions setMissingDataPointFillSettings(DataFeedMissingDataPointFillSettings dataFeedMissingDataPointFillSettings)

Set the data feed, data point fill properties.

Parameters:

dataFeedMissingDataPointFillSettings - the data point fill settings value to set.

Returns:

the DataFeedOptions object itself.

setRollupSettings

public DataFeedOptions setRollupSettings(DataFeedRollupSettings dataFeedRollupSettings)

Set the data feed roll up properties.

Parameters:

dataFeedRollupSettings - the data roll up settings value to set.

Returns:

the DataFeedOptions object itself.

setViewers

public DataFeedOptions setViewers(List viewers)

Set the list of data feed viewer emails and clientIds.

The Viewers have read-only access to a DataFeed. Each element in this list represents a user with viewer access, but the value of each string element is either user email address or clientId uniquely identifying the user service principal.

Parameters:

viewers - a list containing email or clientId of viewers.

Returns:

the DataFeedOptions object itself.