Class MetricMetadata.Builder (0.55.0)

public static final class MetricMetadata.Builder extends GeneratedMessageV3.Builder<MetricMetadata.Builder> implements MetricMetadataOrBuilder

Explains a metric.

Protobuf type google.analytics.data.v1beta.MetricMetadata

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllBlockedReasons(Iterable<? extends MetricMetadata.BlockedReason> values)

public MetricMetadata.Builder addAllBlockedReasons(Iterable<? extends MetricMetadata.BlockedReason> values)

If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric.

To learn more, see Access and data-restriction management.

repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;

Parameter
Name Description
values Iterable<? extends com.google.analytics.data.v1beta.MetricMetadata.BlockedReason>

The blockedReasons to add.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

addAllBlockedReasonsValue(Iterable<Integer> values)

public MetricMetadata.Builder addAllBlockedReasonsValue(Iterable<Integer> values)

If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric.

To learn more, see Access and data-restriction management.

repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for blockedReasons to add.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

addAllDeprecatedApiNames(Iterable<String> values)

public MetricMetadata.Builder addAllDeprecatedApiNames(Iterable<String> values)

Still usable but deprecated names for this metric. If populated, this metric is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the metric will be available only by apiName.

repeated string deprecated_api_names = 4;

Parameter
Name Description
values Iterable<String>

The deprecatedApiNames to add.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

addBlockedReasons(MetricMetadata.BlockedReason value)

public MetricMetadata.Builder addBlockedReasons(MetricMetadata.BlockedReason value)

If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric.

To learn more, see Access and data-restriction management.

repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;

Parameter
Name Description
value MetricMetadata.BlockedReason

The blockedReasons to add.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

addBlockedReasonsValue(int value)

public MetricMetadata.Builder addBlockedReasonsValue(int value)

If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric.

To learn more, see Access and data-restriction management.

repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;

Parameter
Name Description
value int

The enum numeric value on the wire for blockedReasons to add.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

addDeprecatedApiNames(String value)

public MetricMetadata.Builder addDeprecatedApiNames(String value)

Still usable but deprecated names for this metric. If populated, this metric is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the metric will be available only by apiName.

repeated string deprecated_api_names = 4;

Parameter
Name Description
value String

The deprecatedApiNames to add.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

addDeprecatedApiNamesBytes(ByteString value)

public MetricMetadata.Builder addDeprecatedApiNamesBytes(ByteString value)

Still usable but deprecated names for this metric. If populated, this metric is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the metric will be available only by apiName.

repeated string deprecated_api_names = 4;

Parameter
Name Description
value ByteString

The bytes of the deprecatedApiNames to add.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public MetricMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
MetricMetadata.Builder
Overrides

build()

public MetricMetadata build()
Returns
Type Description
MetricMetadata

buildPartial()

public MetricMetadata buildPartial()
Returns
Type Description
MetricMetadata

clear()

public MetricMetadata.Builder clear()
Returns
Type Description
MetricMetadata.Builder
Overrides

clearApiName()

public MetricMetadata.Builder clearApiName()

A metric name. Useable in Metric's name. For example, eventCount.

string api_name = 1;

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

clearBlockedReasons()

public MetricMetadata.Builder clearBlockedReasons()

If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric.

To learn more, see Access and data-restriction management.

repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

clearCategory()

public MetricMetadata.Builder clearCategory()

The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.

string category = 10;

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

clearCustomDefinition()

public MetricMetadata.Builder clearCustomDefinition()

True if the metric is a custom metric for this property.

bool custom_definition = 7;

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

clearDeprecatedApiNames()

public MetricMetadata.Builder clearDeprecatedApiNames()

Still usable but deprecated names for this metric. If populated, this metric is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the metric will be available only by apiName.

repeated string deprecated_api_names = 4;

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

clearDescription()

public MetricMetadata.Builder clearDescription()

Description of how this metric is used and calculated.

string description = 3;

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

clearExpression()

public MetricMetadata.Builder clearExpression()

The mathematical expression for this derived metric. Can be used in Metric's expression field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty.

string expression = 6;

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public MetricMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
MetricMetadata.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public MetricMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
MetricMetadata.Builder
Overrides

clearType()

public MetricMetadata.Builder clearType()

The type of this metric.

.google.analytics.data.v1beta.MetricType type = 5;

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

clearUiName()

public MetricMetadata.Builder clearUiName()

This metric's name within the Google Analytics user interface. For example, Event count.

string ui_name = 2;

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

clone()

public MetricMetadata.Builder clone()
Returns
Type Description
MetricMetadata.Builder
Overrides

getApiName()

public String getApiName()

A metric name. Useable in Metric's name. For example, eventCount.

string api_name = 1;

Returns
Type Description
String

The apiName.

getApiNameBytes()

public ByteString getApiNameBytes()

A metric name. Useable in Metric's name. For example, eventCount.

string api_name = 1;

Returns
Type Description
ByteString

The bytes for apiName.

getBlockedReasons(int index)

public MetricMetadata.BlockedReason getBlockedReasons(int index)

If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric.

To learn more, see Access and data-restriction management.

repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
MetricMetadata.BlockedReason

The blockedReasons at the given index.

getBlockedReasonsCount()

public int getBlockedReasonsCount()

If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric.

To learn more, see Access and data-restriction management.

repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;

Returns
Type Description
int

The count of blockedReasons.

getBlockedReasonsList()

public List<MetricMetadata.BlockedReason> getBlockedReasonsList()

If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric.

To learn more, see Access and data-restriction management.

repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;

Returns
Type Description
List<BlockedReason>

A list containing the blockedReasons.

getBlockedReasonsValue(int index)

public int getBlockedReasonsValue(int index)

If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric.

To learn more, see Access and data-restriction management.

repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

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

getBlockedReasonsValueList()

public List<Integer> getBlockedReasonsValueList()

If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric.

To learn more, see Access and data-restriction management.

repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;

Returns
Type Description
List<Integer>

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

getCategory()

public String getCategory()

The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.

string category = 10;

Returns
Type Description
String

The category.

getCategoryBytes()

public ByteString getCategoryBytes()

The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.

string category = 10;

Returns
Type Description
ByteString

The bytes for category.

getCustomDefinition()

public boolean getCustomDefinition()

True if the metric is a custom metric for this property.

bool custom_definition = 7;

Returns
Type Description
boolean

The customDefinition.

getDefaultInstanceForType()

public MetricMetadata getDefaultInstanceForType()
Returns
Type Description
MetricMetadata

getDeprecatedApiNames(int index)

public String getDeprecatedApiNames(int index)

Still usable but deprecated names for this metric. If populated, this metric is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the metric will be available only by apiName.

repeated string deprecated_api_names = 4;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The deprecatedApiNames at the given index.

getDeprecatedApiNamesBytes(int index)

public ByteString getDeprecatedApiNamesBytes(int index)

Still usable but deprecated names for this metric. If populated, this metric is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the metric will be available only by apiName.

repeated string deprecated_api_names = 4;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the deprecatedApiNames at the given index.

getDeprecatedApiNamesCount()

public int getDeprecatedApiNamesCount()

Still usable but deprecated names for this metric. If populated, this metric is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the metric will be available only by apiName.

repeated string deprecated_api_names = 4;

Returns
Type Description
int

The count of deprecatedApiNames.

getDeprecatedApiNamesList()

public ProtocolStringList getDeprecatedApiNamesList()

Still usable but deprecated names for this metric. If populated, this metric is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the metric will be available only by apiName.

repeated string deprecated_api_names = 4;

Returns
Type Description
ProtocolStringList

A list containing the deprecatedApiNames.

getDescription()

public String getDescription()

Description of how this metric is used and calculated.

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of how this metric is used and calculated.

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getExpression()

public String getExpression()

The mathematical expression for this derived metric. Can be used in Metric's expression field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty.

string expression = 6;

Returns
Type Description
String

The expression.

getExpressionBytes()

public ByteString getExpressionBytes()

The mathematical expression for this derived metric. Can be used in Metric's expression field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty.

string expression = 6;

Returns
Type Description
ByteString

The bytes for expression.

getType()

public MetricType getType()

The type of this metric.

.google.analytics.data.v1beta.MetricType type = 5;

Returns
Type Description
MetricType

The type.

getTypeValue()

public int getTypeValue()

The type of this metric.

.google.analytics.data.v1beta.MetricType type = 5;

Returns
Type Description
int

The enum numeric value on the wire for type.

getUiName()

public String getUiName()

This metric's name within the Google Analytics user interface. For example, Event count.

string ui_name = 2;

Returns
Type Description
String

The uiName.

getUiNameBytes()

public ByteString getUiNameBytes()

This metric's name within the Google Analytics user interface. For example, Event count.

string ui_name = 2;

Returns
Type Description
ByteString

The bytes for uiName.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(MetricMetadata other)

public MetricMetadata.Builder mergeFrom(MetricMetadata other)
Parameter
Name Description
other MetricMetadata
Returns
Type Description
MetricMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public MetricMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricMetadata.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public MetricMetadata.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
MetricMetadata.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final MetricMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
MetricMetadata.Builder
Overrides

setApiName(String value)

public MetricMetadata.Builder setApiName(String value)

A metric name. Useable in Metric's name. For example, eventCount.

string api_name = 1;

Parameter
Name Description
value String

The apiName to set.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

setApiNameBytes(ByteString value)

public MetricMetadata.Builder setApiNameBytes(ByteString value)

A metric name. Useable in Metric's name. For example, eventCount.

string api_name = 1;

Parameter
Name Description
value ByteString

The bytes for apiName to set.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

setBlockedReasons(int index, MetricMetadata.BlockedReason value)

public MetricMetadata.Builder setBlockedReasons(int index, MetricMetadata.BlockedReason value)

If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric.

To learn more, see Access and data-restriction management.

repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;

Parameters
Name Description
index int

The index to set the value at.

value MetricMetadata.BlockedReason

The blockedReasons to set.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

setBlockedReasonsValue(int index, int value)

public MetricMetadata.Builder setBlockedReasonsValue(int index, int value)

If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric.

To learn more, see Access and data-restriction management.

repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;

Parameters
Name Description
index int

The index to set the value at.

value int

The enum numeric value on the wire for blockedReasons to set.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

setCategory(String value)

public MetricMetadata.Builder setCategory(String value)

The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.

string category = 10;

Parameter
Name Description
value String

The category to set.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

setCategoryBytes(ByteString value)

public MetricMetadata.Builder setCategoryBytes(ByteString value)

The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.

string category = 10;

Parameter
Name Description
value ByteString

The bytes for category to set.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

setCustomDefinition(boolean value)

public MetricMetadata.Builder setCustomDefinition(boolean value)

True if the metric is a custom metric for this property.

bool custom_definition = 7;

Parameter
Name Description
value boolean

The customDefinition to set.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

setDeprecatedApiNames(int index, String value)

public MetricMetadata.Builder setDeprecatedApiNames(int index, String value)

Still usable but deprecated names for this metric. If populated, this metric is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the metric will be available only by apiName.

repeated string deprecated_api_names = 4;

Parameters
Name Description
index int

The index to set the value at.

value String

The deprecatedApiNames to set.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

setDescription(String value)

public MetricMetadata.Builder setDescription(String value)

Description of how this metric is used and calculated.

string description = 3;

Parameter
Name Description
value String

The description to set.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public MetricMetadata.Builder setDescriptionBytes(ByteString value)

Description of how this metric is used and calculated.

string description = 3;

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

setExpression(String value)

public MetricMetadata.Builder setExpression(String value)

The mathematical expression for this derived metric. Can be used in Metric's expression field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty.

string expression = 6;

Parameter
Name Description
value String

The expression to set.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

setExpressionBytes(ByteString value)

public MetricMetadata.Builder setExpressionBytes(ByteString value)

The mathematical expression for this derived metric. Can be used in Metric's expression field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty.

string expression = 6;

Parameter
Name Description
value ByteString

The bytes for expression to set.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public MetricMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
MetricMetadata.Builder
Overrides

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

public MetricMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
MetricMetadata.Builder
Overrides

setType(MetricType value)

public MetricMetadata.Builder setType(MetricType value)

The type of this metric.

.google.analytics.data.v1beta.MetricType type = 5;

Parameter
Name Description
value MetricType

The type to set.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

setTypeValue(int value)

public MetricMetadata.Builder setTypeValue(int value)

The type of this metric.

.google.analytics.data.v1beta.MetricType type = 5;

Parameter
Name Description
value int

The enum numeric value on the wire for type to set.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

setUiName(String value)

public MetricMetadata.Builder setUiName(String value)

This metric's name within the Google Analytics user interface. For example, Event count.

string ui_name = 2;

Parameter
Name Description
value String

The uiName to set.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

setUiNameBytes(ByteString value)

public MetricMetadata.Builder setUiNameBytes(ByteString value)

This metric's name within the Google Analytics user interface. For example, Event count.

string ui_name = 2;

Parameter
Name Description
value ByteString

The bytes for uiName to set.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final MetricMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
MetricMetadata.Builder
Overrides