Class AttributePinResponse

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

Inheritance

object

AttributePinResponse

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.ApmtracesService.Models

Assembly: OCI.DotNetSDK.Apmtraces.dll

Syntax

public class AttributePinResponse

Properties

AttributeName

Declaration

[Required(ErrorMessage = "AttributeName is required.")]
[JsonProperty(PropertyName = "attributeName")]
public string AttributeName { get; set; }

Property Value

Type	Description
string	Attribute that was pinned by this bulk operation.

Remarks

Required

AttributeNameSpace

Declaration

[Required(ErrorMessage = "AttributeNameSpace is required.")]
[JsonProperty(PropertyName = "attributeNameSpace")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AttributePinResponse.AttributeNameSpaceEnum? AttributeNameSpace { get; set; }

Property Value

Type	Description
AttributePinResponse.AttributeNameSpaceEnum?	Namespace of the attribute whose properties were updated. The attributeNameSpace will default to TRACES if it is not passed in.

Remarks

Required

AttributeStatus

Declaration

[Required(ErrorMessage = "AttributeStatus is required.")]
[JsonProperty(PropertyName = "attributeStatus")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AttributePinResponse.AttributeStatusEnum? AttributeStatus { get; set; }

Property Value

Type	Description
AttributePinResponse.AttributeStatusEnum?	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.

Type

Description

AttributePinResponse.AttributeStatusEnum?

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.

Remarks

Required

Notes

Declaration

[Required(ErrorMessage = "Notes is required.")]
[JsonProperty(PropertyName = "notes")]
public string Notes { get; set; }

Property Value

Type	Description
string	Notes added to this attribute.

Remarks

Required

OperationType

Declaration

[Required(ErrorMessage = "OperationType is required.")]
[JsonProperty(PropertyName = "operationType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AttributePinResponse.OperationTypeEnum? OperationType { get; set; }

Property Value

Type	Description
AttributePinResponse.OperationTypeEnum?	Type of operation - pin.

Remarks

Required

TimeUpdated

Declaration

[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

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

Remarks

Required