create_entity: Create an entity with specified tags or replace the tags of...

Description Usage Arguments Value

View source: R/create_entity.R

Description

This method creates a new entity and it's tags or replaces the tags of an existing entity. If only a subset of tags is provided for an existing entity, the remaining tags will be deleted.

Usage

1
2
create_entity(entity, tag_names = character(0), tag_values = character(0),
  enabled = TRUE, verbose = FALSE)

Arguments

entity

Required argument, the name of new entity. To modify some of tags of existing entity and do not change remaining tags use the update_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. The default value is enabled = TRUE.

verbose

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

Value

codeTRUE if creation/replace was successful, FALSE — otherwise.


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