com.google.analytics.data.v1beta

Class MetricMetadata

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.analytics.data.v1beta.MetricMetadata

All Implemented Interfaces:

MetricMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class MetricMetadata
extends com.google.protobuf.GeneratedMessageV3
implements MetricMetadataOrBuilder

 Explains a metric.
 

Protobuf type google.analytics.data.v1beta.MetricMetadata

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetricMetadata.BlockedReason Justifications for why this metric is blocked.
static class	MetricMetadata.Builder Explains a metric.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	API_NAME_FIELD_NUMBER
static int	BLOCKED_REASONS_FIELD_NUMBER
static int	CATEGORY_FIELD_NUMBER
static int	CUSTOM_DEFINITION_FIELD_NUMBER
static int	DEPRECATED_API_NAMES_FIELD_NUMBER
static int	DESCRIPTION_FIELD_NUMBER
static int	EXPRESSION_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER
static int	UI_NAME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getApiName() A metric name.
com.google.protobuf.ByteString	getApiNameBytes() A metric name.
MetricMetadata.BlockedReason	getBlockedReasons(int index) If reasons are specified, your access is blocked to this metric for this property.
int	getBlockedReasonsCount() If reasons are specified, your access is blocked to this metric for this property.
List<MetricMetadata.BlockedReason>	getBlockedReasonsList() If reasons are specified, your access is blocked to this metric for this property.
int	getBlockedReasonsValue(int index) If reasons are specified, your access is blocked to this metric for this property.
List<Integer>	getBlockedReasonsValueList() If reasons are specified, your access is blocked to this metric for this property.
String	getCategory() The display name of the category that this metrics belongs to.
com.google.protobuf.ByteString	getCategoryBytes() The display name of the category that this metrics belongs to.
boolean	getCustomDefinition() True if the metric is a custom metric for this property.
static MetricMetadata	getDefaultInstance()
MetricMetadata	getDefaultInstanceForType()
String	getDeprecatedApiNames(int index) Still usable but deprecated names for this metric.
com.google.protobuf.ByteString	getDeprecatedApiNamesBytes(int index) Still usable but deprecated names for this metric.
int	getDeprecatedApiNamesCount() Still usable but deprecated names for this metric.
com.google.protobuf.ProtocolStringList	getDeprecatedApiNamesList() Still usable but deprecated names for this metric.
String	getDescription() Description of how this metric is used and calculated.
com.google.protobuf.ByteString	getDescriptionBytes() Description of how this metric is used and calculated.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getExpression() The mathematical expression for this derived metric.
com.google.protobuf.ByteString	getExpressionBytes() The mathematical expression for this derived metric.
com.google.protobuf.Parser<MetricMetadata>	getParserForType()
int	getSerializedSize()
MetricType	getType() The type of this metric.
int	getTypeValue() The type of this metric.
String	getUiName() This metric's name within the Google Analytics user interface.
com.google.protobuf.ByteString	getUiNameBytes() This metric's name within the Google Analytics user interface.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static MetricMetadata.Builder	newBuilder()
static MetricMetadata.Builder	newBuilder(MetricMetadata prototype)
MetricMetadata.Builder	newBuilderForType()
protected MetricMetadata.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static MetricMetadata	parseDelimitedFrom(InputStream input)
static MetricMetadata	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MetricMetadata	parseFrom(byte[] data)
static MetricMetadata	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MetricMetadata	parseFrom(ByteBuffer data)
static MetricMetadata	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MetricMetadata	parseFrom(com.google.protobuf.ByteString data)
static MetricMetadata	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MetricMetadata	parseFrom(com.google.protobuf.CodedInputStream input)
static MetricMetadata	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MetricMetadata	parseFrom(InputStream input)
static MetricMetadata	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<MetricMetadata>	parser()
MetricMetadata.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

API_NAME_FIELD_NUMBER

public static final int API_NAME_FIELD_NUMBER

See Also:

Constant Field Values

UI_NAME_FIELD_NUMBER

public static final int UI_NAME_FIELD_NUMBER

See Also:

Constant Field Values

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

DEPRECATED_API_NAMES_FIELD_NUMBER

public static final int DEPRECATED_API_NAMES_FIELD_NUMBER

See Also:

Constant Field Values

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

EXPRESSION_FIELD_NUMBER

public static final int EXPRESSION_FIELD_NUMBER

See Also:

Constant Field Values

CUSTOM_DEFINITION_FIELD_NUMBER

public static final int CUSTOM_DEFINITION_FIELD_NUMBER

See Also:

Constant Field Values

BLOCKED_REASONS_FIELD_NUMBER

public static final int BLOCKED_REASONS_FIELD_NUMBER

See Also:

Constant Field Values

CATEGORY_FIELD_NUMBER

public static final int CATEGORY_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

getApiName

public String getApiName()

 A metric name. Useable in [Metric](#Metric)'s `name`. For example,
 `eventCount`.
 

string api_name = 1;

Specified by:

getApiName in interface MetricMetadataOrBuilder

Returns:

The apiName.

getApiNameBytes

public com.google.protobuf.ByteString getApiNameBytes()

 A metric name. Useable in [Metric](#Metric)'s `name`. For example,
 `eventCount`.
 

string api_name = 1;

Specified by:

getApiNameBytes in interface MetricMetadataOrBuilder

Returns:

The bytes for apiName.

getUiName

public String getUiName()

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

string ui_name = 2;

Specified by:

getUiName in interface MetricMetadataOrBuilder

Returns:

The uiName.

getUiNameBytes

public com.google.protobuf.ByteString getUiNameBytes()

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

string ui_name = 2;

Specified by:

getUiNameBytes in interface MetricMetadataOrBuilder

Returns:

The bytes for uiName.

getDescription

public String getDescription()

 Description of how this metric is used and calculated.
 

string description = 3;

Specified by:

getDescription in interface MetricMetadataOrBuilder

Returns:

The description.

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

 Description of how this metric is used and calculated.
 

string description = 3;

Specified by:

getDescriptionBytes in interface MetricMetadataOrBuilder

Returns:

The bytes for description.

getDeprecatedApiNamesList

public com.google.protobuf.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;

Specified by:

getDeprecatedApiNamesList in interface MetricMetadataOrBuilder

Returns:

A list containing the deprecatedApiNames.

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;

Specified by:

getDeprecatedApiNamesCount in interface MetricMetadataOrBuilder

Returns:

The count of deprecatedApiNames.

getDeprecatedApiNames

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;

Specified by:

getDeprecatedApiNames in interface MetricMetadataOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The deprecatedApiNames at the given index.

getDeprecatedApiNamesBytes

public com.google.protobuf.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;

Specified by:

getDeprecatedApiNamesBytes in interface MetricMetadataOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the deprecatedApiNames at the given index.

getTypeValue

public int getTypeValue()

 The type of this metric.
 

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

Specified by:

getTypeValue in interface MetricMetadataOrBuilder

Returns:

The enum numeric value on the wire for type.

getType

public MetricType getType()

 The type of this metric.
 

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

Specified by:

getType in interface MetricMetadataOrBuilder

Returns:

The type.

getExpression

public String getExpression()

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

string expression = 6;

Specified by:

getExpression in interface MetricMetadataOrBuilder

Returns:

The expression.

getExpressionBytes

public com.google.protobuf.ByteString getExpressionBytes()

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

string expression = 6;

Specified by:

getExpressionBytes in interface MetricMetadataOrBuilder

Returns:

The bytes for expression.

getCustomDefinition

public boolean getCustomDefinition()

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

bool custom_definition = 7;

Specified by:

getCustomDefinition in interface MetricMetadataOrBuilder

Returns:

The customDefinition.

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](https://support.google.com/analytics/answer/10851388).
 

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

Specified by:

getBlockedReasonsList in interface MetricMetadataOrBuilder

Returns:

A list containing the blockedReasons.

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](https://support.google.com/analytics/answer/10851388).
 

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

Specified by:

getBlockedReasonsCount in interface MetricMetadataOrBuilder

Returns:

The count of blockedReasons.

getBlockedReasons

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](https://support.google.com/analytics/answer/10851388).
 

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

Specified by:

getBlockedReasons in interface MetricMetadataOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The 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](https://support.google.com/analytics/answer/10851388).
 

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

Specified by:

getBlockedReasonsValueList in interface MetricMetadataOrBuilder

Returns:

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

getBlockedReasonsValue

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](https://support.google.com/analytics/answer/10851388).
 

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

Specified by:

getBlockedReasonsValue in interface MetricMetadataOrBuilder

Parameters:

index - The index of the value to return.

Returns:

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

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;

Specified by:

getCategory in interface MetricMetadataOrBuilder

Returns:

The category.

getCategoryBytes

public com.google.protobuf.ByteString getCategoryBytes()

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

string category = 10;

Specified by:

getCategoryBytes in interface MetricMetadataOrBuilder

Returns:

The bytes for category.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static MetricMetadata parseFrom(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MetricMetadata parseFrom(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MetricMetadata parseFrom(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MetricMetadata parseFrom(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MetricMetadata parseFrom(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MetricMetadata parseFrom(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MetricMetadata parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static MetricMetadata parseFrom(InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static MetricMetadata parseDelimitedFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static MetricMetadata parseDelimitedFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseFrom

public static MetricMetadata parseFrom(com.google.protobuf.CodedInputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static MetricMetadata parseFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

newBuilderForType

public MetricMetadata.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static MetricMetadata.Builder newBuilder()

newBuilder

public static MetricMetadata.Builder newBuilder(MetricMetadata prototype)

toBuilder

public MetricMetadata.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected MetricMetadata.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static MetricMetadata getDefaultInstance()

parser

public static com.google.protobuf.Parser<MetricMetadata> parser()

getParserForType

public com.google.protobuf.Parser<MetricMetadata> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public MetricMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder