ITraceCounterBuilder

​

Interface ITraceCounterBuilder

interface ITraceCounterBuilder

Extends com.amazon.apmf.IStandard ITraceCounterBuilder interface is a builder for emitting counter calls, used to track an item throughout a trace capture. When using ITraceCounterBuilder, a name must be passed to properly create the object. All other categories are optional.

​

Methods

​

name()

ITraceCounterBuilder* name(string name)

Sets the name of counter track for ITraceCounterBuilder

​

Parameters

name

string — Required Name of counter track.

​

Returns

ITraceCounterBuilder* ITraceCounterBuilder with set counter track name.

---

​

unit()

ITraceCounterBuilder* unit(string unit)

Sets the unit name of counter track for ITraceCounterBuilder

​

Parameters

unit

string — Required Name of unit to be displayed with counter.

​

Returns

ITraceCounterBuilder* ITraceCounterBuilder with set unit name.

---

​

multiplier()

ITraceCounterBuilder* multiplier(i32 multiplier)

Sets the multiplier of counter track for ITraceCounterBuilder

​

Parameters

multiplier

i32 — Required Multiplier to be used by passed values.

​

Returns

ITraceCounterBuilder* ITraceCounterBuilder with set multiplier.

---

​

incremental()

ITraceCounterBuilder* incremental(bool isIncremental)

Defines if counter track is incremental for ITraceCounterBuilder. Passed values will increment the value of counter track rather then set the value

​

Parameters

isIncremental

bool — Required Boolean define if to increment value.

​

Returns

ITraceCounterBuilder* ITraceCounterBuilder with set isIncremental value.

---

​

build()

ITraceCounter* build()

Builds an instance of ITraceCounter with set parameters from previous methods.

​

Returns

ITraceCounter* ITraceCounter with set parameters.

---