AdaptixUpdateStream: Update an Adaptix stream

Description Usage Arguments Value Examples

Description

Update an Adaptix stream

Usage

1
2
3
4
AdaptixUpdateStream(conn, streamURL = NULL, streamID = NULL, name = NULL,
  device = NULL, description = NULL, units = NULL,
  anomaly.monitoring = F, store.points = T, data.rate = NULL,
  verbose = FALSE)

Arguments

conn

a valid Adaptix connection object.

streamURL

the location of the stream, as a URL (as provided in the "href" field of API responses).

streamID

the stream id (ignored if streamURL is provided)

name

the name of the stream.

device

if not NULL, associates the stream with a device.

description

the name of the stream.

units

if not NULL, documents the unit ofor this stream's data.

anomaly.monitoring

[REQUIRES ANOMALY DETECTION APP TO BE ENABLED] Enable anomaly detection on this stream.

store.points

wether or not to store the points

data.rate

if not NULL, indicates the normal data rate for the points of this stream.

verbose

display HTTP operation details.

Value

the newly created stream information, as a list

Examples

1
AdaptixUpdateStream(conn = conn, name = "my_stream", verbose = F)

Sensewaves/AdaptixR documentation built on May 28, 2019, 2:44 p.m.