BulkPinMetadata¶

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

Bases: object

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

Attributes

`OPERATION_STATUS_EMPTY_ATTRIBUTE_LIST`	A constant which can be used with the operation_status property of a BulkPinMetadata.
`OPERATION_STATUS_INVALID_BULK_REQUEST`	A constant which can be used with the operation_status property of a BulkPinMetadata.
`OPERATION_STATUS_SUCCESS`	A constant which can be used with the operation_status property of a BulkPinMetadata.
`OPERATION_TYPE_PIN`	A constant which can be used with the operation_type property of a BulkPinMetadata.
`attributes_pinned`	[Required] Gets the attributes_pinned of this BulkPinMetadata.
`operation_status`	[Required] Gets the operation_status of this BulkPinMetadata.
`operation_type`	[Required] Gets the operation_type of this BulkPinMetadata.
`synthetic_attributes_pinned`	Gets the synthetic_attributes_pinned of this BulkPinMetadata.

Methods

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

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

__init__(**kwargs)¶

Initializes a new BulkPinMetadata 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 BulkPinMetadata. 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 BulkPinMetadata. Allowed values for this property are: “PIN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
attributes_pinned (int) – The value to assign to the attributes_pinned property of this BulkPinMetadata.
synthetic_attributes_pinned (int) – The value to assign to the synthetic_attributes_pinned property of this BulkPinMetadata.

attributes_pinned¶

[Required] Gets the attributes_pinned of this BulkPinMetadata. Total number attributes (both string and numeric) in TRACES namespace that were pinned.

Returns:	The attributes_pinned of this BulkPinMetadata.
Return type:	int

operation_status¶

[Required] Gets the operation_status of this BulkPinMetadata. Operation status of the bulk pin operation. SUCCESS - The bulk pin operation has succeeded and all the attributes in the bulk pin request have been pinned by this operation or pinned earlier. The following are error statuses for the bulk pin operation. EMPTY_ATTRIBUTE_LIST - The bulk pin request object was empty and did not contain any attributes to be pinned. 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 BulkPinMetadata.
Return type:	str

operation_type¶

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

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 BulkPinMetadata.
Return type:	str

synthetic_attributes_pinned¶

Gets the synthetic_attributes_pinned of this BulkPinMetadata. Total number attributes (both string and numeric) in SYNTHETIC namespace that were pinned.

Returns:	The synthetic_attributes_pinned of this BulkPinMetadata.
Return type:	int