Class Metric.Builder (0.24.0)

public static final class Metric.Builder extends GeneratedMessageV3.Builder<Metric.Builder> implements MetricOrBuilder

The quantitative measurements of a report. For example, the metric eventCount is the total number of events. Requests are allowed up to 10 metrics.

Protobuf type google.analytics.data.v1beta.Metric

Implements

MetricOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Metric.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Metric.Builder
Overrides

build()

public Metric build()
Returns
TypeDescription
Metric

buildPartial()

public Metric buildPartial()
Returns
TypeDescription
Metric

clear()

public Metric.Builder clear()
Returns
TypeDescription
Metric.Builder
Overrides

clearExpression()

public Metric.Builder clearExpression()

A mathematical expression for derived metrics. For example, the metric Event count per user is eventCount/totalUsers.

string expression = 2;

Returns
TypeDescription
Metric.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Metric.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Metric.Builder
Overrides

clearInvisible()

public Metric.Builder clearInvisible()

Indicates if a metric is invisible in the report response. If a metric is invisible, the metric will not produce a column in the response, but can be used in metricFilter, orderBys, or a metric expression.

bool invisible = 3;

Returns
TypeDescription
Metric.Builder

This builder for chaining.

clearName()

public Metric.Builder clearName()

The name of the metric. See the API Metrics for the list of metric names. If expression is specified, name can be any string that you would like within the allowed character set. For example if expression is screenPageViews/sessions, you could call that metric's name = viewsPerSession. Metric names that you choose must match the regular expression ^[a-zA-Z0-9_]$. Metrics are referenced by name in metricFilter, orderBys, and metric expression.

string name = 1;

Returns
TypeDescription
Metric.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Metric.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Metric.Builder
Overrides

clone()

public Metric.Builder clone()
Returns
TypeDescription
Metric.Builder
Overrides

getDefaultInstanceForType()

public Metric getDefaultInstanceForType()
Returns
TypeDescription
Metric

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getExpression()

public String getExpression()

A mathematical expression for derived metrics. For example, the metric Event count per user is eventCount/totalUsers.

string expression = 2;

Returns
TypeDescription
String

The expression.

getExpressionBytes()

public ByteString getExpressionBytes()

A mathematical expression for derived metrics. For example, the metric Event count per user is eventCount/totalUsers.

string expression = 2;

Returns
TypeDescription
ByteString

The bytes for expression.

getInvisible()

public boolean getInvisible()

Indicates if a metric is invisible in the report response. If a metric is invisible, the metric will not produce a column in the response, but can be used in metricFilter, orderBys, or a metric expression.

bool invisible = 3;

Returns
TypeDescription
boolean

The invisible.

getName()

public String getName()

The name of the metric. See the API Metrics for the list of metric names. If expression is specified, name can be any string that you would like within the allowed character set. For example if expression is screenPageViews/sessions, you could call that metric's name = viewsPerSession. Metric names that you choose must match the regular expression ^[a-zA-Z0-9_]$. Metrics are referenced by name in metricFilter, orderBys, and metric expression.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of the metric. See the API Metrics for the list of metric names. If expression is specified, name can be any string that you would like within the allowed character set. For example if expression is screenPageViews/sessions, you could call that metric's name = viewsPerSession. Metric names that you choose must match the regular expression ^[a-zA-Z0-9_]$. Metrics are referenced by name in metricFilter, orderBys, and metric expression.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Metric other)

public Metric.Builder mergeFrom(Metric other)
Parameter
NameDescription
otherMetric
Returns
TypeDescription
Metric.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Metric.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Metric.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Metric.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Metric.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Metric.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Metric.Builder
Overrides

setExpression(String value)

public Metric.Builder setExpression(String value)

A mathematical expression for derived metrics. For example, the metric Event count per user is eventCount/totalUsers.

string expression = 2;

Parameter
NameDescription
valueString

The expression to set.

Returns
TypeDescription
Metric.Builder

This builder for chaining.

setExpressionBytes(ByteString value)

public Metric.Builder setExpressionBytes(ByteString value)

A mathematical expression for derived metrics. For example, the metric Event count per user is eventCount/totalUsers.

string expression = 2;

Parameter
NameDescription
valueByteString

The bytes for expression to set.

Returns
TypeDescription
Metric.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Metric.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Metric.Builder
Overrides

setInvisible(boolean value)

public Metric.Builder setInvisible(boolean value)

Indicates if a metric is invisible in the report response. If a metric is invisible, the metric will not produce a column in the response, but can be used in metricFilter, orderBys, or a metric expression.

bool invisible = 3;

Parameter
NameDescription
valueboolean

The invisible to set.

Returns
TypeDescription
Metric.Builder

This builder for chaining.

setName(String value)

public Metric.Builder setName(String value)

The name of the metric. See the API Metrics for the list of metric names. If expression is specified, name can be any string that you would like within the allowed character set. For example if expression is screenPageViews/sessions, you could call that metric's name = viewsPerSession. Metric names that you choose must match the regular expression ^[a-zA-Z0-9_]$. Metrics are referenced by name in metricFilter, orderBys, and metric expression.

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Metric.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Metric.Builder setNameBytes(ByteString value)

The name of the metric. See the API Metrics for the list of metric names. If expression is specified, name can be any string that you would like within the allowed character set. For example if expression is screenPageViews/sessions, you could call that metric's name = viewsPerSession. Metric names that you choose must match the regular expression ^[a-zA-Z0-9_]$. Metrics are referenced by name in metricFilter, orderBys, and metric expression.

string name = 1;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Metric.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Metric.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Metric.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Metric.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Metric.Builder
Overrides