com.google.analytics.data.v1beta

Class Metric.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<Metric.Builder>

com.google.analytics.data.v1beta.Metric.Builder

All Implemented Interfaces:

MetricOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

Metric

public static final class Metric.Builder
extends com.google.protobuf.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

Method Summary

Modifier and Type	Method and Description
Metric.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Metric	build()
Metric	buildPartial()
Metric.Builder	clear()
Metric.Builder	clearExpression() A mathematical expression for derived metrics.
Metric.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Metric.Builder	clearInvisible() Indicates if a metric is invisible in the report response.
Metric.Builder	clearName() The name of the metric.
Metric.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Metric.Builder	clone()
Metric	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getExpression() A mathematical expression for derived metrics.
com.google.protobuf.ByteString	getExpressionBytes() A mathematical expression for derived metrics.
boolean	getInvisible() Indicates if a metric is invisible in the report response.
String	getName() The name of the metric.
com.google.protobuf.ByteString	getNameBytes() The name of the metric.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Metric.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Metric.Builder	mergeFrom(com.google.protobuf.Message other)
Metric.Builder	mergeFrom(Metric other)
Metric.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Metric.Builder	setExpression(String value) A mathematical expression for derived metrics.
Metric.Builder	setExpressionBytes(com.google.protobuf.ByteString value) A mathematical expression for derived metrics.
Metric.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Metric.Builder	setInvisible(boolean value) Indicates if a metric is invisible in the report response.
Metric.Builder	setName(String value) The name of the metric.
Metric.Builder	setNameBytes(com.google.protobuf.ByteString value) The name of the metric.
Metric.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Metric.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Metric.Builder>

clear

public Metric.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Metric.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Metric.Builder>

getDefaultInstanceForType

public Metric getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Metric build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Metric buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Metric.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Metric.Builder>

setField

public Metric.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                               Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Metric.Builder>

clearField

public Metric.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Metric.Builder>

clearOneof

public Metric.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Metric.Builder>

setRepeatedField

public Metric.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       int index,
                                       Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Metric.Builder>

addRepeatedField

public Metric.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Metric.Builder>

mergeFrom

public Metric.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Metric.Builder>

mergeFrom

public Metric.Builder mergeFrom(Metric other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Metric.Builder>

mergeFrom

public Metric.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Metric.Builder>

Throws:

IOException

getName

public String getName()

 The name of the metric. See the [API
 Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#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;

Specified by:

getName in interface MetricOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 The name of the metric. See the [API
 Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#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;

Specified by:

getNameBytes in interface MetricOrBuilder

Returns:

The bytes for name.

setName

public Metric.Builder setName(String value)

 The name of the metric. See the [API
 Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#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;

Parameters:

value - The name to set.

Returns:

This builder for chaining.

clearName

public Metric.Builder clearName()

 The name of the metric. See the [API
 Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#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:

This builder for chaining.

setNameBytes

public Metric.Builder setNameBytes(com.google.protobuf.ByteString value)

 The name of the metric. See the [API
 Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#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;

Parameters:

value - The bytes for name to set.

Returns:

This builder for chaining.

getExpression

public String getExpression()

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

string expression = 2;

Specified by:

getExpression in interface MetricOrBuilder

Returns:

The expression.

getExpressionBytes

public com.google.protobuf.ByteString getExpressionBytes()

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

string expression = 2;

Specified by:

getExpressionBytes in interface MetricOrBuilder

Returns:

The bytes for expression.

setExpression

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;

Parameters:

value - The expression to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setExpressionBytes

public Metric.Builder setExpressionBytes(com.google.protobuf.ByteString value)

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

string expression = 2;

Parameters:

value - The bytes for expression to set.

Returns:

This builder for chaining.

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;

Specified by:

getInvisible in interface MetricOrBuilder

Returns:

The invisible.

setInvisible

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;

Parameters:

value - The invisible to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setUnknownFields

public final Metric.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Metric.Builder>

mergeUnknownFields

public final Metric.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Metric.Builder>