BulkUnpinMetadata¶

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

Bases: object

Metadata about the bulk unpin operation. The bulk unpin operation is atomic and binary. If the processing of any of the attributes in the bulk unpin request results in a processing or validation error, then none of the attributes in the request are unpinned.

Attributes

`OPERATION_STATUS_EMPTY_ATTRIBUTE_LIST`	A constant which can be used with the operation_status property of a BulkUnpinMetadata.
`OPERATION_STATUS_INVALID_BULK_REQUEST`	A constant which can be used with the operation_status property of a BulkUnpinMetadata.
`OPERATION_STATUS_SUCCESS`	A constant which can be used with the operation_status property of a BulkUnpinMetadata.
`OPERATION_TYPE_UNPIN`	A constant which can be used with the operation_type property of a BulkUnpinMetadata.
`attributes_unpinned`	[Required] Gets the attributes_unpinned of this BulkUnpinMetadata.
`operation_status`	[Required] Gets the operation_status of this BulkUnpinMetadata.
`operation_type`	[Required] Gets the operation_type of this BulkUnpinMetadata.
`synthetic_attributes_unpinned`	Gets the synthetic_attributes_unpinned of this BulkUnpinMetadata.

Methods

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

OPERATION_STATUS_EMPTY_ATTRIBUTE_LIST = 'EMPTY_ATTRIBUTE_LIST'¶: A constant which can be used with the operation_status property of a BulkUnpinMetadata. This constant has a value of “EMPTY_ATTRIBUTE_LIST”

OPERATION_STATUS_INVALID_BULK_REQUEST = 'INVALID_BULK_REQUEST'¶: A constant which can be used with the operation_status property of a BulkUnpinMetadata. This constant has a value of “INVALID_BULK_REQUEST”

OPERATION_STATUS_SUCCESS = 'SUCCESS'¶: A constant which can be used with the operation_status property of a BulkUnpinMetadata. This constant has a value of “SUCCESS”

OPERATION_TYPE_UNPIN = 'UNPIN'¶: A constant which can be used with the operation_type property of a BulkUnpinMetadata. This constant has a value of “UNPIN”

__init__(**kwargs)¶

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

Parameters:

operation_status (str) – The value to assign to the operation_status property of this BulkUnpinMetadata. Allowed values for this property are: “SUCCESS”, “EMPTY_ATTRIBUTE_LIST”, “INVALID_BULK_REQUEST”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
operation_type (str) – The value to assign to the operation_type property of this BulkUnpinMetadata. Allowed values for this property are: “UNPIN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
attributes_unpinned (int) – The value to assign to the attributes_unpinned property of this BulkUnpinMetadata.
synthetic_attributes_unpinned (int) – The value to assign to the synthetic_attributes_unpinned property of this BulkUnpinMetadata.

attributes_unpinned¶

[Required] Gets the attributes_unpinned of this BulkUnpinMetadata. Total number attributes (both string and numeric) in TRACES namespace that were unpinned.

Returns:	The attributes_unpinned of this BulkUnpinMetadata.
Return type:	int

operation_status¶

[Required] Gets the operation_status of this BulkUnpinMetadata. Operation status of the bulk unpin operation. SUCCESS - The bulk unpin operation has succeeded and all the attributes in the bulk unpin request have been unpinned by this operation. The following are error statuses for the bulk unpin operation. EMPTY_ATTRIBUTE_LIST - The bulk unpin request object was empty and did not contain any attributes to be unpinned. INVALID_BULK_REQUEST - The bulk request contains invalid attribute(s), or attribute(s) that resulted in a validation error, or an attribute that resulted in a processing error.

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

Returns:	The operation_status of this BulkUnpinMetadata.
Return type:	str

operation_type¶

[Required] Gets the operation_type of this BulkUnpinMetadata. Type of operation.

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

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

synthetic_attributes_unpinned¶

Gets the synthetic_attributes_unpinned of this BulkUnpinMetadata. Total number attributes (both string and numeric) in SYNTHETIC namespace that were unpinned.

Returns:	The synthetic_attributes_unpinned of this BulkUnpinMetadata.
Return type:	int