Class DataFeedOptions
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the data feed access mode, default is Private.Get the action link for alert.Get the list of data feed administrator emails and clientIds.Get the dataFeedDescription property: data feed description.Get the data feed data point fill properties.Get the data feed roll up properties.Get the list of data feed viewer emails and clientIds.setAccessMode
(DataFeedAccessMode dataFeedAccessMode) Set the data feed access mode, default is Private.setActionLinkTemplate
(String actionLinkTemplate) Set the action link for alert.Set the list of data feed administrator emails and clientIds.setDescription
(String dataFeedDescription) Set the dataFeedDescription property: data feed description.setMissingDataPointFillSettings
(DataFeedMissingDataPointFillSettings dataFeedMissingDataPointFillSettings) Set the data feed, data point fill properties.setRollupSettings
(DataFeedRollupSettings dataFeedRollupSettings) Set the data feed roll up properties.setViewers
(List<String> viewers) Set the list of data feed viewer emails and clientIds.
-
Constructor Details
-
DataFeedOptions
public DataFeedOptions()
-
-
Method Details
-
getRollupSettings
Get the data feed roll up properties.- Returns:
- the data feed roll up properties.
-
getMissingDataPointFillSettings
Get the data feed data point fill properties.- Returns:
- the data point fill properties.
-
setRollupSettings
Set the data feed roll up properties.- Parameters:
dataFeedRollupSettings
- the data roll up settings 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.
-
getAccessMode
Get the data feed access mode, default is Private.- Returns:
- the DataFeedAccessMode value.
-
setAccessMode
Set the data feed access mode, default is Private.- Parameters:
dataFeedAccessMode
- the value to set.- Returns:
- the DataFeedOptions object itself.
-
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
-
setAdmins
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.
-
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
-
setViewers
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.
-
getDescription
Get the dataFeedDescription property: data feed description.- Returns:
- the dataFeedDescription value.
-
setDescription
Set the dataFeedDescription property: data feed description.- Parameters:
dataFeedDescription
- the dataFeedDescription value to set.- Returns:
- the DataFeedOptions object itself.
-
getActionLinkTemplate
Get the action link for alert.- Returns:
- the actionLinkTemplate value.
-
setActionLinkTemplate
Set the action link for alert.- Parameters:
actionLinkTemplate
- the actionLinkTemplate value to set.- Returns:
- the DataFeedOptions object itself.
-