tracdap.rt.metadata.tag_update

Module Contents

Classes

TagOperation

Enumeration of available TagUpdate operations.

TagUpdate

A tag update is a request for a single update operation on a tag.

class tracdap.rt.metadata.tag_update.TagOperation

Bases: enum.Enum

Enumeration of available TagUpdate operations.

See also

TagUpdate

APPEND_ATTR = [4, 'Append one or more values to an existing attribute, fail if the attribute\n    does not...
CLEAR_ALL_ATTR = [6, 'Remove all the attributes from a tag.\n    \n    This operation does not affect controlled...
CREATE_ATTR = [2, 'Add an attribute to a tag, fail if the attribute already exists.']
CREATE_OR_APPEND_ATTR = [1, 'Add an attribute to a tag or append to it if it already exists.\n    \n    If the attribute...
CREATE_OR_REPLACE_ATTR = [0, 'Add an attribute to a tag or replace it if it already exists.\n    \n    This is the...
DELETE_ATTR = [5, 'Remove an attribute from a tag, fail if the attribute does not exist.']
REPLACE_ATTR = [3, 'Replace an attribute on a tag, fail if the attribute does not exist.\n    \n    When...
class tracdap.rt.metadata.tag_update.TagUpdate

A tag update is a request for a single update operation on a tag.

Tag updates can be supplied to TRAC via an API call to request updates to a tag. They may also be included in TRAC policy objects or client application logic, to describe a set of operations that is performed in response to a particular action.

See also

MetadataWriteRequest

attrName

Name of the attribute this update refers to.

This field must be supplied for operations that refer to a single attribute, otherwise it should be left blank.

Type

str

operation

The operation requested in this update

See also

TagOperation

Type

TagOperation

value

Attribute value to use for this update.

This field must be supplied for operations that use a value, otherwise it should be omitted.

See also

Value

Type

Optional[Value]