update_entity: Update tags and enabled status of an entity.

Description Usage Arguments Value

View source: R/update_entity.R

Description

Update specified tags and enabled status of an existing entity. Tags that are not specified are left unchanged.

Usage

1
2
update_entity(entity, tag_names = character(0), tag_values = character(0),
  enabled = NA, verbose = FALSE)

Arguments

entity

Required argument, an entity name. The entity should exist into ATSD. In case you want to create new entity use the create_entity function.

tag_names

Optional argument, a character vector of names of tags.

tag_values

Optional argument, a character vector of values of tags. This vector should has the same length as the tag_names vector.

enabled

Optional boolean argument. If enabled = TRUE the entity will be enabled, if enabled = FALSE the entity will be disabled, in the default case enabled = NA the enabled status of entity will not be changed.

verbose

Optional boolean argument, FALSE by default. If verbose = FALSE then console output will be suppressed.

Value

codeTRUE if update success, FALSE — otherwise.


atsd documentation built on May 2, 2019, 4:06 p.m.