AttributePinResponse¶

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

Bases: object

Response of an individual attribute item in the bulk pin operation.

Attributes

`ATTRIBUTE_NAME_SPACE_SYNTHETIC`	A constant which can be used with the attribute_name_space property of a AttributePinResponse.
`ATTRIBUTE_NAME_SPACE_TRACES`	A constant which can be used with the attribute_name_space property of a AttributePinResponse.
`ATTRIBUTE_STATUS_ATTRIBUTE_ALREADY_PINNED`	A constant which can be used with the attribute_status property of a AttributePinResponse.
`ATTRIBUTE_STATUS_ATTRIBUTE_NOT_PROCESSED`	A constant which can be used with the attribute_status property of a AttributePinResponse.
`ATTRIBUTE_STATUS_ATTRIBUTE_PINNED`	A constant which can be used with the attribute_status property of a AttributePinResponse.
`ATTRIBUTE_STATUS_DUPLICATE_ATTRIBUTE`	A constant which can be used with the attribute_status property of a AttributePinResponse.
`ATTRIBUTE_STATUS_INVALID_ATTRIBUTE`	A constant which can be used with the attribute_status property of a AttributePinResponse.
`ATTRIBUTE_STATUS_PIN_NOT_ALLOWED`	A constant which can be used with the attribute_status property of a AttributePinResponse.
`OPERATION_TYPE_PIN`	A constant which can be used with the operation_type property of a AttributePinResponse.
`attribute_name`	[Required] Gets the attribute_name of this AttributePinResponse.
`attribute_name_space`	[Required] Gets the attribute_name_space of this AttributePinResponse.
`attribute_status`	[Required] Gets the attribute_status of this AttributePinResponse.
`notes`	[Required] Gets the notes of this AttributePinResponse.
`operation_type`	[Required] Gets the operation_type of this AttributePinResponse.
`time_updated`	[Required] Gets the time_updated of this AttributePinResponse.

Methods

__init__(**kwargs) Initializes a new AttributePinResponse 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 AttributePinResponse. 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 AttributePinResponse. This constant has a value of “TRACES”

ATTRIBUTE_STATUS_ATTRIBUTE_ALREADY_PINNED = 'ATTRIBUTE_ALREADY_PINNED'¶: A constant which can be used with the attribute_status property of a AttributePinResponse. This constant has a value of “ATTRIBUTE_ALREADY_PINNED”

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

ATTRIBUTE_STATUS_ATTRIBUTE_PINNED = 'ATTRIBUTE_PINNED'¶: A constant which can be used with the attribute_status property of a AttributePinResponse. This constant has a value of “ATTRIBUTE_PINNED”

ATTRIBUTE_STATUS_DUPLICATE_ATTRIBUTE = 'DUPLICATE_ATTRIBUTE'¶: A constant which can be used with the attribute_status property of a AttributePinResponse. 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 AttributePinResponse. This constant has a value of “INVALID_ATTRIBUTE”

ATTRIBUTE_STATUS_PIN_NOT_ALLOWED = 'PIN_NOT_ALLOWED'¶: A constant which can be used with the attribute_status property of a AttributePinResponse. This constant has a value of “PIN_NOT_ALLOWED”

OPERATION_TYPE_PIN = 'PIN'¶: A constant which can be used with the operation_type property of a AttributePinResponse. This constant has a value of “PIN”

__init__(**kwargs)¶

Initializes a new AttributePinResponse 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 AttributePinResponse.
notes (str) – The value to assign to the notes property of this AttributePinResponse.
operation_type (str) – The value to assign to the operation_type property of this AttributePinResponse. Allowed values for this property are: “PIN”, ‘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 AttributePinResponse. 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 AttributePinResponse. Allowed values for this property are: “ATTRIBUTE_ALREADY_PINNED”, “ATTRIBUTE_PINNED”, “PIN_NOT_ALLOWED”, “DUPLICATE_ATTRIBUTE”, “INVALID_ATTRIBUTE”, “ATTRIBUTE_NOT_PROCESSED”, ‘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 AttributePinResponse.

attribute_name¶

[Required] Gets the attribute_name of this AttributePinResponse. Attribute that was pinned by this bulk operation.

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

attribute_name_space¶

[Required] Gets the attribute_name_space of this AttributePinResponse. 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 AttributePinResponse.
Return type:	str

attribute_status¶

[Required] Gets the attribute_status of this AttributePinResponse. Status of the attribute after this operation. The attribute can have one of the following statuses after the pin 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 successfully and they get a success status back. The following are successful status values of individual attribute items in a bulk attribute pin operation. ATTRIBUTE_PINNED - The attribute is marked pinned and associated notes have been added. ATTRIBUTE_ALREADY_PINNED - The caller is trying to pin an attribute that has already been pinned. 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. PIN_NOT_ALLOWED - The caller has asked to pin an active attribute which is not allowed. INVALID_ATTRIBUTE - The attribute is invalid. ATTRIBUTE_NOT_PROCESSED - The attribute was not processed, as there was another attribute in this bulk request collection that resulted in a processing error.

Allowed values for this property are: “ATTRIBUTE_ALREADY_PINNED”, “ATTRIBUTE_PINNED”, “PIN_NOT_ALLOWED”, “DUPLICATE_ATTRIBUTE”, “INVALID_ATTRIBUTE”, “ATTRIBUTE_NOT_PROCESSED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

notes¶

[Required] Gets the notes of this AttributePinResponse. Notes added to this attribute.

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

operation_type¶

[Required] Gets the operation_type of this AttributePinResponse. Type of operation - pin.

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

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

time_updated¶

[Required] Gets the time_updated of this AttributePinResponse. 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 AttributePinResponse.
Return type:	datetime