Entity Class

Represents the common part for both Segment and Subsegment.

Inheritance Hierarchy

SystemObject
  Amazon.XRay.Recorder.Core.Internal.EntitiesEntity
    Amazon.XRay.Recorder.Core.Internal.EntitiesSegment
    Amazon.XRay.Recorder.Core.Internal.EntitiesSubsegment

Namespace: Amazon.XRay.Recorder.Core.Internal.Entities
Assembly: AWSXRayRecorder.Core (in AWSXRayRecorder.Core.dll) Version: 2.14.0+018bfa65877dd72e346735bad4d7ad46f217da09

Syntax

Copy

[SerializableAttribute]
public abstract class Entity

The Entity type exposes the following members.

Constructors

	Name	Description
	Entity	Initializes a new instance of the Entity class.

Top

Properties

	Name	Description
	Annotations	Gets the annotations of the segment
	Aws	Gets aws information
	Cause	Gets the cause of fault or error
	EndTime	Gets or sets the end time of this segment with Unix time in seconds.
	HasError	Gets or sets a value indicating whether the segment has errored
	HasFault	Gets or sets a value indicating whether the segment has faulted or failed
	HasStreamed	Gets or sets a value indicating whether the entity has been streamed
	Http	Gets the http attribute
	Id	Gets or sets the unique id of segment.
	IsAnnotationsAdded	Gets a value indicating whether any annotations have been added.
	IsAwsAdded	Gets a value indicating whether aws information has been added.
	IsHttpAdded	Gets a value indicating whether any HTTP information has been added.
	IsInProgress	Gets or sets a value indicating whether the segment is in progress
	IsMetadataAdded	Gets a value indicating whether any metadata has been added.
	IsSqlAdded	Gets a value indicating whether any SQL information has been added.
	IsSubsegmentsAdded	Gets a value indicating whether any subsegments have been added.
	IsThrottled	Gets or sets a value indicating whether the remote segment is throttled
	Metadata	Gets the metadata.
	Name	Gets or sets the name of the service component.
	ParentId	Gets or sets the unique id of upstream segment
	Reference	Gets reference of this instance of segment
	RootSegment	Gets or sets the root segment
	Sampled	Gets or sets the sample decision
	Sql	Gets the SQL information
	StartTime	Gets or sets the start time of this segment with Unix time in seconds.
	Subsegments	Gets a readonly copy of the subsegment list.
	TraceId	Gets or sets the unique id for the trace.

Top

Methods

	Name	Description
	AddAnnotation	Adds the specified key and value as annotation to current segment. The type of value is restricted. Only String, Int32, Int64, Double and Boolean are supported.
	AddException	Adds the exception to cause and set this segment to has fault.
	AddMetadata(String, Object)	Adds the specific key and value to metadata under default namespace.
	AddMetadata(String, String, Object)	Adds the specific key and value to metadata under given namespace.
	AddSubsegment	Add a subsegment
	DecrementReferenceCounter	Release reference to this instance of segment
	GenerateId	Generates the id for entity.
	IncrementReferenceCounter	Add reference to this instance of segment
	IsEmittable	Check if this segment or the root segment that this segment belongs to is ok to emit
	IsIdValid	Validate the segment id
	Release	Release reference to this instance of segment
	SetEndTime(DateTime)	Sets end time of the entity to the provided timestamp.
	SetEndTime(Decimal)	Sets end time of the entity to the provided timestamp.
	SetEndTimeToNow	Set end time of the entity to current time
	SetStartTime(DateTime)	Sets start time of the entity to the provided timestamp.
	SetStartTime(Decimal)	Sets start time of the entity to the provided timestamp.
	SetStartTimeToNow	Set start time of the entity to current time

Top

Reference

Amazon.XRay.Recorder.Core.Internal.Entities Namespace