AttributeResponse¶

class oci.apm_traces.models.AttributeResponse(**kwargs)¶

Bases: object

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

Attributes

`ATTRIBUTE_NAME_SPACE_SYNTHETIC`	A constant which can be used with the attribute_name_space property of a AttributeResponse.
`ATTRIBUTE_NAME_SPACE_TRACES`	A constant which can be used with the attribute_name_space property of a AttributeResponse.
`ATTRIBUTE_STATUS_ATTRIBUTE_ACTIVATED`	A constant which can be used with the attribute_status property of a AttributeResponse.
`ATTRIBUTE_STATUS_ATTRIBUTE_ALREADY_ACTIVE`	A constant which can be used with the attribute_status property of a AttributeResponse.
`ATTRIBUTE_STATUS_ATTRIBUTE_ALREADY_DEACTIVATED`	A constant which can be used with the attribute_status property of a AttributeResponse.
`ATTRIBUTE_STATUS_ATTRIBUTE_DEACTIVATED`	A constant which can be used with the attribute_status property of a AttributeResponse.
`ATTRIBUTE_STATUS_ATTRIBUTE_DOES_NOT_EXIST`	A constant which can be used with the attribute_status property of a AttributeResponse.
`ATTRIBUTE_STATUS_ATTRIBUTE_NOT_PROCESSED`	A constant which can be used with the attribute_status property of a AttributeResponse.
`ATTRIBUTE_STATUS_ATTRIBUTE_UPDATE_NOT_ALLOWED`	A constant which can be used with the attribute_status property of a AttributeResponse.
`ATTRIBUTE_STATUS_DEACTIVATION_NOT_ALLOWED`	A constant which can be used with the attribute_status property of a AttributeResponse.
`ATTRIBUTE_STATUS_DUPLICATE_ATTRIBUTE`	A constant which can be used with the attribute_status property of a AttributeResponse.
`ATTRIBUTE_STATUS_INVALID_ATTRIBUTE`	A constant which can be used with the attribute_status property of a AttributeResponse.
`ATTRIBUTE_STATUS_INVALID_ATTRIBUTE_TYPE_CONFLICT`	A constant which can be used with the attribute_status property of a AttributeResponse.
`ATTRIBUTE_TYPE_NUMERIC`	A constant which can be used with the attribute_type property of a AttributeResponse.
`ATTRIBUTE_TYPE_STRING`	A constant which can be used with the attribute_type property of a AttributeResponse.
`OPERATION_TYPE_ACTIVATE`	A constant which can be used with the operation_type property of a AttributeResponse.
`OPERATION_TYPE_DEACTIVATE`	A constant which can be used with the operation_type property of a AttributeResponse.
`UNIT_BYTES`	A constant which can be used with the unit property of a AttributeResponse.
`UNIT_COUNT`	A constant which can be used with the unit property of a AttributeResponse.
`UNIT_DURATION_MS`	A constant which can be used with the unit property of a AttributeResponse.
`UNIT_EPOCH_TIME_MS`	A constant which can be used with the unit property of a AttributeResponse.
`UNIT_NONE`	A constant which can be used with the unit property of a AttributeResponse.
`UNIT_PERCENTAGE`	A constant which can be used with the unit property of a AttributeResponse.
`UNIT_TRACE_STATUS`	A constant which can be used with the unit property of a AttributeResponse.
`attribute_name`	[Required] Gets the attribute_name of this AttributeResponse.
`attribute_name_space`	[Required] Gets the attribute_name_space of this AttributeResponse.
`attribute_status`	[Required] Gets the attribute_status of this AttributeResponse.
`attribute_type`	[Required] Gets the attribute_type of this AttributeResponse.
`notes`	Gets the notes of this AttributeResponse.
`operation_type`	[Required] Gets the operation_type of this AttributeResponse.
`time_updated`	[Required] Gets the time_updated of this AttributeResponse.
`unit`	Gets the unit of this AttributeResponse.

Methods

__init__(**kwargs) Initializes a new AttributeResponse object with values from keyword arguments.

ATTRIBUTE_NAME_SPACE_SYNTHETIC = 'SYNTHETIC'¶: A constant which can be used with the attribute_name_space property of a AttributeResponse. This constant has a value of “SYNTHETIC”

ATTRIBUTE_NAME_SPACE_TRACES = 'TRACES'¶: A constant which can be used with the attribute_name_space property of a AttributeResponse. This constant has a value of “TRACES”

ATTRIBUTE_STATUS_ATTRIBUTE_ACTIVATED = 'ATTRIBUTE_ACTIVATED'¶: A constant which can be used with the attribute_status property of a AttributeResponse. This constant has a value of “ATTRIBUTE_ACTIVATED”

ATTRIBUTE_STATUS_ATTRIBUTE_ALREADY_ACTIVE = 'ATTRIBUTE_ALREADY_ACTIVE'¶: A constant which can be used with the attribute_status property of a AttributeResponse. This constant has a value of “ATTRIBUTE_ALREADY_ACTIVE”

ATTRIBUTE_STATUS_ATTRIBUTE_ALREADY_DEACTIVATED = 'ATTRIBUTE_ALREADY_DEACTIVATED'¶: A constant which can be used with the attribute_status property of a AttributeResponse. This constant has a value of “ATTRIBUTE_ALREADY_DEACTIVATED”

ATTRIBUTE_STATUS_ATTRIBUTE_DEACTIVATED = 'ATTRIBUTE_DEACTIVATED'¶: A constant which can be used with the attribute_status property of a AttributeResponse. This constant has a value of “ATTRIBUTE_DEACTIVATED”

ATTRIBUTE_STATUS_ATTRIBUTE_DOES_NOT_EXIST = 'ATTRIBUTE_DOES_NOT_EXIST'¶: A constant which can be used with the attribute_status property of a AttributeResponse. This constant has a value of “ATTRIBUTE_DOES_NOT_EXIST”

ATTRIBUTE_STATUS_ATTRIBUTE_NOT_PROCESSED = 'ATTRIBUTE_NOT_PROCESSED'¶: A constant which can be used with the attribute_status property of a AttributeResponse. This constant has a value of “ATTRIBUTE_NOT_PROCESSED”

ATTRIBUTE_STATUS_ATTRIBUTE_UPDATE_NOT_ALLOWED = 'ATTRIBUTE_UPDATE_NOT_ALLOWED'¶: A constant which can be used with the attribute_status property of a AttributeResponse. This constant has a value of “ATTRIBUTE_UPDATE_NOT_ALLOWED”

ATTRIBUTE_STATUS_DEACTIVATION_NOT_ALLOWED = 'DEACTIVATION_NOT_ALLOWED'¶: A constant which can be used with the attribute_status property of a AttributeResponse. This constant has a value of “DEACTIVATION_NOT_ALLOWED”

ATTRIBUTE_STATUS_DUPLICATE_ATTRIBUTE = 'DUPLICATE_ATTRIBUTE'¶: A constant which can be used with the attribute_status property of a AttributeResponse. This constant has a value of “DUPLICATE_ATTRIBUTE”

ATTRIBUTE_STATUS_INVALID_ATTRIBUTE = 'INVALID_ATTRIBUTE'¶: A constant which can be used with the attribute_status property of a AttributeResponse. This constant has a value of “INVALID_ATTRIBUTE”

ATTRIBUTE_STATUS_INVALID_ATTRIBUTE_TYPE_CONFLICT = 'INVALID_ATTRIBUTE_TYPE_CONFLICT'¶: A constant which can be used with the attribute_status property of a AttributeResponse. This constant has a value of “INVALID_ATTRIBUTE_TYPE_CONFLICT”

ATTRIBUTE_TYPE_NUMERIC = 'NUMERIC'¶: A constant which can be used with the attribute_type property of a AttributeResponse. This constant has a value of “NUMERIC”

ATTRIBUTE_TYPE_STRING = 'STRING'¶: A constant which can be used with the attribute_type property of a AttributeResponse. This constant has a value of “STRING”

OPERATION_TYPE_ACTIVATE = 'ACTIVATE'¶: A constant which can be used with the operation_type property of a AttributeResponse. This constant has a value of “ACTIVATE”

OPERATION_TYPE_DEACTIVATE = 'DEACTIVATE'¶: A constant which can be used with the operation_type property of a AttributeResponse. This constant has a value of “DEACTIVATE”

UNIT_BYTES = 'BYTES'¶: A constant which can be used with the unit property of a AttributeResponse. This constant has a value of “BYTES”

UNIT_COUNT = 'COUNT'¶: A constant which can be used with the unit property of a AttributeResponse. This constant has a value of “COUNT”

UNIT_DURATION_MS = 'DURATION_MS'¶: A constant which can be used with the unit property of a AttributeResponse. This constant has a value of “DURATION_MS”

UNIT_EPOCH_TIME_MS = 'EPOCH_TIME_MS'¶: A constant which can be used with the unit property of a AttributeResponse. This constant has a value of “EPOCH_TIME_MS”

UNIT_NONE = 'NONE'¶: A constant which can be used with the unit property of a AttributeResponse. This constant has a value of “NONE”

UNIT_PERCENTAGE = 'PERCENTAGE'¶: A constant which can be used with the unit property of a AttributeResponse. This constant has a value of “PERCENTAGE”

UNIT_TRACE_STATUS = 'TRACE_STATUS'¶: A constant which can be used with the unit property of a AttributeResponse. This constant has a value of “TRACE_STATUS”

__init__(**kwargs)¶

Initializes a new AttributeResponse object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

attribute_name (str) – The value to assign to the attribute_name property of this AttributeResponse.
attribute_type (str) – The value to assign to the attribute_type property of this AttributeResponse. Allowed values for this property are: “NUMERIC”, “STRING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
unit (str) – The value to assign to the unit property of this AttributeResponse. Allowed values for this property are: “NONE”, “EPOCH_TIME_MS”, “BYTES”, “COUNT”, “DURATION_MS”, “TRACE_STATUS”, “PERCENTAGE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
notes (str) – The value to assign to the notes property of this AttributeResponse.
operation_type (str) – The value to assign to the operation_type property of this AttributeResponse. Allowed values for this property are: “ACTIVATE”, “DEACTIVATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
attribute_name_space (str) – The value to assign to the attribute_name_space property of this AttributeResponse. Allowed values for this property are: “TRACES”, “SYNTHETIC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
attribute_status (str) – The value to assign to the attribute_status property of this AttributeResponse. Allowed values for this property are: “ATTRIBUTE_ALREADY_ACTIVE”, “ATTRIBUTE_ACTIVATED”, “ATTRIBUTE_DEACTIVATED”, “DEACTIVATION_NOT_ALLOWED”, “ATTRIBUTE_DOES_NOT_EXIST”, “ATTRIBUTE_ALREADY_DEACTIVATED”, “DUPLICATE_ATTRIBUTE”, “INVALID_ATTRIBUTE”, “INVALID_ATTRIBUTE_TYPE_CONFLICT”, “ATTRIBUTE_NOT_PROCESSED”, “ATTRIBUTE_UPDATE_NOT_ALLOWED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_updated (datetime) – The value to assign to the time_updated property of this AttributeResponse.

attribute_name¶

[Required] Gets the attribute_name of this AttributeResponse. Attribute that was activated or deactivated by this bulk operation.

Returns:	The attribute_name of this AttributeResponse.
Return type:	str

attribute_name_space¶

[Required] Gets the attribute_name_space of this AttributeResponse. Namespace of the attribute whose properties were updated. The attributeNamespace will default to TRACES if it is not passed in.

Allowed values for this property are: “TRACES”, “SYNTHETIC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The attribute_name_space of this AttributeResponse.
Return type:	str

attribute_status¶

[Required] Gets the attribute_status of this AttributeResponse. 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.

Allowed values for this property are: “ATTRIBUTE_ALREADY_ACTIVE”, “ATTRIBUTE_ACTIVATED”, “ATTRIBUTE_DEACTIVATED”, “DEACTIVATION_NOT_ALLOWED”, “ATTRIBUTE_DOES_NOT_EXIST”, “ATTRIBUTE_ALREADY_DEACTIVATED”, “DUPLICATE_ATTRIBUTE”, “INVALID_ATTRIBUTE”, “INVALID_ATTRIBUTE_TYPE_CONFLICT”, “ATTRIBUTE_NOT_PROCESSED”, “ATTRIBUTE_UPDATE_NOT_ALLOWED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The attribute_status of this AttributeResponse.
Return type:	str

attribute_type¶

[Required] Gets the attribute_type of this AttributeResponse. Type of the attribute.

Allowed values for this property are: “NUMERIC”, “STRING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The attribute_type of this AttributeResponse.
Return type:	str

notes¶

Gets the notes of this AttributeResponse. Notes for the activated attribute.

Returns:	The notes of this AttributeResponse.
Return type:	str

operation_type¶

[Required] Gets the operation_type of this AttributeResponse. Type of operation - activate or deactivate.

Allowed values for this property are: “ACTIVATE”, “DEACTIVATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The operation_type of this AttributeResponse.
Return type:	str

time_updated¶

[Required] Gets the time_updated of this AttributeResponse. Time when the attribute was activated or deactivated. Note that ingest might not have picked up the changes even if this time has elapsed.

Returns:	The time_updated of this AttributeResponse.
Return type:	datetime

unit¶

Gets the unit of this AttributeResponse. Unit of the attribute.

Allowed values for this property are: “NONE”, “EPOCH_TIME_MS”, “BYTES”, “COUNT”, “DURATION_MS”, “TRACE_STATUS”, “PERCENTAGE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The unit of this AttributeResponse.
Return type:	str