Interface MetricOrBuilder (0.3.0)

public interface MetricOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDimensions(int index)

public abstract Metric.Dimension getDimensions(int index)

All group by clauses used to calculate the metric.

repeated .google.backstory.Metric.Dimension dimensions = 6;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
Metric.Dimension

The dimensions at the given index.

getDimensionsCount()

public abstract int getDimensionsCount()

All group by clauses used to calculate the metric.

repeated .google.backstory.Metric.Dimension dimensions = 6;

Returns
Type Description
int

The count of dimensions.

getDimensionsList()

public abstract List<Metric.Dimension> getDimensionsList()

All group by clauses used to calculate the metric.

repeated .google.backstory.Metric.Dimension dimensions = 6;

Returns
Type Description
List<Dimension>

A list containing the dimensions.

getDimensionsValue(int index)

public abstract int getDimensionsValue(int index)

All group by clauses used to calculate the metric.

repeated .google.backstory.Metric.Dimension dimensions = 6;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of dimensions at the given index.

getDimensionsValueList()

public abstract List<Integer> getDimensionsValueList()

All group by clauses used to calculate the metric.

repeated .google.backstory.Metric.Dimension dimensions = 6;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for dimensions.

getDisplayName()

public abstract String getDisplayName()

Display name of the custom metric. Google-authored metrics do not have a display name.

string display_name = 8;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Display name of the custom metric. Google-authored metrics do not have a display name.

string display_name = 8;

Returns
Type Description
ByteString

The bytes for displayName.

getExportWindow()

public abstract long getExportWindow()

Export window for which the metric was exported.

int64 export_window = 7;

Returns
Type Description
long

The exportWindow.

getFirstSeen()

public abstract Timestamp getFirstSeen()

Timestamp of the first time the entity was seen in the environment.

.google.protobuf.Timestamp first_seen = 1;

Returns
Type Description
Timestamp

The firstSeen.

getFirstSeenOrBuilder()

public abstract TimestampOrBuilder getFirstSeenOrBuilder()

Timestamp of the first time the entity was seen in the environment.

.google.protobuf.Timestamp first_seen = 1;

Returns
Type Description
TimestampOrBuilder

getLastSeen()

public abstract Timestamp getLastSeen()

Time stamp of the last time last time the entity was seen in the environment.

.google.protobuf.Timestamp last_seen = 2;

Returns
Type Description
Timestamp

The lastSeen.

getLastSeenOrBuilder()

public abstract TimestampOrBuilder getLastSeenOrBuilder()

Time stamp of the last time last time the entity was seen in the environment.

.google.protobuf.Timestamp last_seen = 2;

Returns
Type Description
TimestampOrBuilder

getMatchVariables(int index)

public abstract FindingVariable getMatchVariables(int index)

List of match variables used in the custom metric.

repeated .google.backstory.FindingVariable match_variables = 10;

Parameter
Name Description
index int
Returns
Type Description
FindingVariable

getMatchVariablesCount()

public abstract int getMatchVariablesCount()

List of match variables used in the custom metric.

repeated .google.backstory.FindingVariable match_variables = 10;

Returns
Type Description
int

getMatchVariablesList()

public abstract List<FindingVariable> getMatchVariablesList()

List of match variables used in the custom metric.

repeated .google.backstory.FindingVariable match_variables = 10;

Returns
Type Description
List<FindingVariable>

getMatchVariablesOrBuilder(int index)

public abstract FindingVariableOrBuilder getMatchVariablesOrBuilder(int index)

List of match variables used in the custom metric.

repeated .google.backstory.FindingVariable match_variables = 10;

Parameter
Name Description
index int
Returns
Type Description
FindingVariableOrBuilder

getMatchVariablesOrBuilderList()

public abstract List<? extends FindingVariableOrBuilder> getMatchVariablesOrBuilderList()

List of match variables used in the custom metric.

repeated .google.backstory.FindingVariable match_variables = 10;

Returns
Type Description
List<? extends com.google.backstory.FindingVariableOrBuilder>

getMetricName()

public abstract Metric.MetricName getMetricName()

Name of the analytic.

.google.backstory.Metric.MetricName metric_name = 5;

Returns
Type Description
Metric.MetricName

The metricName.

getMetricNameValue()

public abstract int getMetricNameValue()

Name of the analytic.

.google.backstory.Metric.MetricName metric_name = 5;

Returns
Type Description
int

The enum numeric value on the wire for metricName.

getOutcomeVariables(int index)

public abstract FindingVariable getOutcomeVariables(int index)

List of outcome variables used in the custom metric.

repeated .google.backstory.FindingVariable outcome_variables = 9;

Parameter
Name Description
index int
Returns
Type Description
FindingVariable

getOutcomeVariablesCount()

public abstract int getOutcomeVariablesCount()

List of outcome variables used in the custom metric.

repeated .google.backstory.FindingVariable outcome_variables = 9;

Returns
Type Description
int

getOutcomeVariablesList()

public abstract List<FindingVariable> getOutcomeVariablesList()

List of outcome variables used in the custom metric.

repeated .google.backstory.FindingVariable outcome_variables = 9;

Returns
Type Description
List<FindingVariable>

getOutcomeVariablesOrBuilder(int index)

public abstract FindingVariableOrBuilder getOutcomeVariablesOrBuilder(int index)

List of outcome variables used in the custom metric.

repeated .google.backstory.FindingVariable outcome_variables = 9;

Parameter
Name Description
index int
Returns
Type Description
FindingVariableOrBuilder

getOutcomeVariablesOrBuilderList()

public abstract List<? extends FindingVariableOrBuilder> getOutcomeVariablesOrBuilderList()

List of outcome variables used in the custom metric.

repeated .google.backstory.FindingVariable outcome_variables = 9;

Returns
Type Description
List<? extends com.google.backstory.FindingVariableOrBuilder>

getSumMeasure()

public abstract Metric.Measure getSumMeasure()

Sum of all precomputed measures for the given metric.

.google.backstory.Metric.Measure sum_measure = 3;

Returns
Type Description
Metric.Measure

The sumMeasure.

getSumMeasureOrBuilder()

public abstract Metric.MeasureOrBuilder getSumMeasureOrBuilder()

Sum of all precomputed measures for the given metric.

.google.backstory.Metric.Measure sum_measure = 3;

Returns
Type Description
Metric.MeasureOrBuilder

getTimeRange()

public abstract Interval getTimeRange()

Time range for which the custom metric was calculated.

.google.type.Interval time_range = 11;

Returns
Type Description
com.google.type.Interval

The timeRange.

getTimeRangeOrBuilder()

public abstract IntervalOrBuilder getTimeRangeOrBuilder()

Time range for which the custom metric was calculated.

.google.type.Interval time_range = 11;

Returns
Type Description
com.google.type.IntervalOrBuilder

getTotalEvents()

public abstract long getTotalEvents()

Total number of events used to calculate the given precomputed metric.

int64 total_events = 4;

Returns
Type Description
long

The totalEvents.

hasFirstSeen()

public abstract boolean hasFirstSeen()

Timestamp of the first time the entity was seen in the environment.

.google.protobuf.Timestamp first_seen = 1;

Returns
Type Description
boolean

Whether the firstSeen field is set.

hasLastSeen()

public abstract boolean hasLastSeen()

Time stamp of the last time last time the entity was seen in the environment.

.google.protobuf.Timestamp last_seen = 2;

Returns
Type Description
boolean

Whether the lastSeen field is set.

hasSumMeasure()

public abstract boolean hasSumMeasure()

Sum of all precomputed measures for the given metric.

.google.backstory.Metric.Measure sum_measure = 3;

Returns
Type Description
boolean

Whether the sumMeasure field is set.

hasTimeRange()

public abstract boolean hasTimeRange()

Time range for which the custom metric was calculated.

.google.type.Interval time_range = 11;

Returns
Type Description
boolean

Whether the timeRange field is set.