Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace AttributeResponse

Response of an individual attribute item in the bulk activate or deactivate operation.

Properties

attributeName

attributeName: string

Attribute that was activated or deactivated by this bulk operation.

attributeNameSpace

attributeNameSpace: AttributeNameSpace

Namespace of the attribute whose properties were updated. The attributeNamespace will default to TRACES if it is not passed in.

attributeStatus

attributeStatus: AttributeStatus

Status of the attribute after this operation. The attribute can have one of the following statuses after the activate or deactivate operation. The attribute can have either a success status or an error status. The status of the attribute must be correlated with the operation status property in the bulk operation metadata object. The bulk operation will be successful only when all attributes in the bulk request are processed successful and they get a success status back. The following are successful status values of individual attribute items in a bulk attribute activation operation. ATTRIBUTE_ACTIVATED - The attribute is activated and is available to be queried. Note that ingest might still have not picked up the changes, and the associated caches would not have refreshed yet to pick up the changes. ATTRIBUTE_ALREADY_ACTIVE - The caller is trying to activate an attribute that is already active or in the process of getting activated. ATTRIBUTE_DEACTIVATED - The attribute is deactivated and will not appear in searches. Ingest might not have picked up the new changes and the associated caches might not have refreshed yet. ATTRIBUTE_ALREADY_DEACTIVATED - The caller is trying to deactivate an attribute that has already been deactivated or in the process of deactivation. DUPLICATE_ATTRIBUTE - The attribute is a duplicate of an attribute that was present in this bulk request. Note that we deduplicate the attribute collection, process only unique attributes, and call out duplicates. A duplicate attribute in a bulk request will not prevent the processing of further attributes in the bulk operation. The following values are error statuses and the bulk processing is stopped when the first error is encountered. None of the attributes in the bulk request would have been activated or deactivated by this bulk operation. DEACTIVATION_NOT_ALLOWED - The caller has asked for the deactivation of an out of box tag which is not permitted. ATTRIBUTE_DOES_NOT_EXIST - The caller tries to deactivate an attribute that doesn't exist in the APM Domain. INVALID_ATTRIBUTE - The attribute is invalid. INVALID_ATTRIBUTE_TYPE_CONFLICT - The attribute is invalid. There were two attributes with same name but different type in the bulk request. ATTRIBUTE_NOT_PROCESSED - The attribute was not processed, as there was another attribute in this bulk request collection that resulted in a processing error. ATTRIBUTE_UPDATE_NOT_ALLOWED - The unit of the attribute cannot be updated as it is an in-built system attribute.

attributeType

attributeType: AttributeType

Type of the attribute.

Optional notes

notes: undefined | string

Notes for the activated attribute.

operationType

operationType: OperationType

Type of operation - activate or deactivate.

timeUpdated

timeUpdated: Date

Time when the attribute was activated or deactivated. Note that ingest might not have picked up the changes even if this time has elapsed.

Optional unit

unit: Unit

Unit of the attribute.

Functions

getDeserializedJsonObj

getJsonObj