Class Metric (0.3.0)

0.3.0 (latest) 0.2.0 0.1.0

public final class Metric extends GeneratedMessage implements MetricOrBuilder

Stores precomputed aggregated analytic data for an entity.

Protobuf type google.backstory.Metric

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > Metric

Implements

MetricOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

DIMENSIONS_FIELD_NUMBER

public static final int DIMENSIONS_FIELD_NUMBER

Field Value
Type	Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

Field Value
Type	Description
int

EXPORT_WINDOW_FIELD_NUMBER

public static final int EXPORT_WINDOW_FIELD_NUMBER

Field Value
Type	Description
int

FIRST_SEEN_FIELD_NUMBER

public static final int FIRST_SEEN_FIELD_NUMBER

Field Value
Type	Description
int

LAST_SEEN_FIELD_NUMBER

public static final int LAST_SEEN_FIELD_NUMBER

Field Value
Type	Description
int

MATCH_VARIABLES_FIELD_NUMBER

public static final int MATCH_VARIABLES_FIELD_NUMBER

Field Value
Type	Description
int

METRIC_NAME_FIELD_NUMBER

public static final int METRIC_NAME_FIELD_NUMBER

Field Value
Type	Description
int

OUTCOME_VARIABLES_FIELD_NUMBER

public static final int OUTCOME_VARIABLES_FIELD_NUMBER

Field Value
Type	Description
int

SUM_MEASURE_FIELD_NUMBER

public static final int SUM_MEASURE_FIELD_NUMBER

Field Value
Type	Description
int

TIME_RANGE_FIELD_NUMBER

public static final int TIME_RANGE_FIELD_NUMBER

Field Value
Type	Description
int

TOTAL_EVENTS_FIELD_NUMBER

public static final int TOTAL_EVENTS_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static Metric getDefaultInstance()

Returns
Type	Description
Metric

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static Metric.Builder newBuilder()

Returns
Type	Description
Metric.Builder

newBuilder(Metric prototype)

public static Metric.Builder newBuilder(Metric prototype)

Parameter
Name	Description
prototype	Metric

Returns
Type	Description
Metric.Builder

parseDelimitedFrom(InputStream input)

public static Metric parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Metric

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Metric parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Metric

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Metric parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Metric

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Metric parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Metric

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Metric parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Metric

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Metric parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Metric

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Metric parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Metric

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Metric parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Metric

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Metric parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Metric

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Metric parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Metric

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Metric parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Metric

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Metric parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Metric

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Metric> parser()

Returns
Type	Description
Parser<Metric>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public Metric getDefaultInstanceForType()

Returns
Type	Description
Metric

getDimensions(int index)

public 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 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 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 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 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 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 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 long getExportWindow()

Export window for which the metric was exported.

int64 export_window = 7;

Returns
Type	Description
long	The exportWindow.

getFirstSeen()

public 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 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 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 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 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 int getMatchVariablesCount()

List of match variables used in the custom metric.

repeated .google.backstory.FindingVariable match_variables = 10;

Returns
Type	Description
int

getMatchVariablesList()

public 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 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 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 Metric.MetricName getMetricName()

Name of the analytic.

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

Returns
Type	Description
Metric.MetricName	The metricName.

getMetricNameValue()

public 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 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 int getOutcomeVariablesCount()

List of outcome variables used in the custom metric.

repeated .google.backstory.FindingVariable outcome_variables = 9;

Returns
Type	Description
int

getOutcomeVariablesList()

public 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 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 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>

getParserForType()

public Parser<Metric> getParserForType()

Returns
Type	Description
Parser<Metric>

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

getSumMeasure()

public 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 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 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 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 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 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 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 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 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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public Metric.Builder newBuilderForType()

Returns
Type	Description
Metric.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Metric.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Metric.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public Metric.Builder toBuilder()

Returns
Type	Description
Metric.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException