Package com.google.analytics.data.v1beta
Class MetricMetadata
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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
@Generated
public final class MetricMetadata
extends com.google.protobuf.GeneratedMessage
implements MetricMetadataOrBuilder
Explains a metric.Protobuf type
google.analytics.data.v1beta.MetricMetadata- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumJustifications for why this metric is blocked.static final classExplains a metric.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanA metric name.com.google.protobuf.ByteStringA metric name.getBlockedReasons(int index) If reasons are specified, your access is blocked to this metric for this property.intIf reasons are specified, your access is blocked to this metric for this property.If reasons are specified, your access is blocked to this metric for this property.intgetBlockedReasonsValue(int index) If reasons are specified, your access is blocked to this metric for this property.If reasons are specified, your access is blocked to this metric for this property.The display name of the category that this metrics belongs to.com.google.protobuf.ByteStringThe display name of the category that this metrics belongs to.booleanTrue if the metric is a custom metric for this property.static MetricMetadatagetDeprecatedApiNames(int index) Still usable but deprecated names for this metric.com.google.protobuf.ByteStringgetDeprecatedApiNamesBytes(int index) Still usable but deprecated names for this metric.intStill usable but deprecated names for this metric.com.google.protobuf.ProtocolStringListStill usable but deprecated names for this metric.Description of how this metric is used and calculated.com.google.protobuf.ByteStringDescription of how this metric is used and calculated.static final com.google.protobuf.Descriptors.DescriptorThe mathematical expression for this derived metric.com.google.protobuf.ByteStringThe mathematical expression for this derived metric.com.google.protobuf.Parser<MetricMetadata>intgetType()The type of this metric.intThe type of this metric.This metric's name within the Google Analytics user interface.com.google.protobuf.ByteStringThis metric's name within the Google Analytics user interface.inthashCode()protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic MetricMetadata.Builderstatic MetricMetadata.BuildernewBuilder(MetricMetadata prototype) protected MetricMetadata.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static MetricMetadataparseDelimitedFrom(InputStream input) static MetricMetadataparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static MetricMetadataparseFrom(byte[] data) static MetricMetadataparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static MetricMetadataparseFrom(com.google.protobuf.ByteString data) static MetricMetadataparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static MetricMetadataparseFrom(com.google.protobuf.CodedInputStream input) static MetricMetadataparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static MetricMetadataparseFrom(InputStream input) static MetricMetadataparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static MetricMetadataparseFrom(ByteBuffer data) static MetricMetadataparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<MetricMetadata>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
API_NAME_FIELD_NUMBER
public static final int API_NAME_FIELD_NUMBER- See Also:
-
UI_NAME_FIELD_NUMBER
public static final int UI_NAME_FIELD_NUMBER- See Also:
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER- See Also:
-
DEPRECATED_API_NAMES_FIELD_NUMBER
public static final int DEPRECATED_API_NAMES_FIELD_NUMBER- See Also:
-
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER- See Also:
-
EXPRESSION_FIELD_NUMBER
public static final int EXPRESSION_FIELD_NUMBER- See Also:
-
CUSTOM_DEFINITION_FIELD_NUMBER
public static final int CUSTOM_DEFINITION_FIELD_NUMBER- See Also:
-
BLOCKED_REASONS_FIELD_NUMBER
public static final int BLOCKED_REASONS_FIELD_NUMBER- See Also:
-
CATEGORY_FIELD_NUMBER
public static final int CATEGORY_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getApiName
A metric name. Useable in [Metric](#Metric)'s `name`. For example, `eventCount`.
string api_name = 1;- Specified by:
getApiNamein interfaceMetricMetadataOrBuilder- 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:
getApiNameBytesin interfaceMetricMetadataOrBuilder- Returns:
- The bytes for apiName.
-
getUiName
This metric's name within the Google Analytics user interface. For example, `Event count`.
string ui_name = 2;- Specified by:
getUiNamein interfaceMetricMetadataOrBuilder- 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:
getUiNameBytesin interfaceMetricMetadataOrBuilder- Returns:
- The bytes for uiName.
-
getDescription
Description of how this metric is used and calculated.
string description = 3;- Specified by:
getDescriptionin interfaceMetricMetadataOrBuilder- Returns:
- The description.
-
getDescriptionBytes
public com.google.protobuf.ByteString getDescriptionBytes()Description of how this metric is used and calculated.
string description = 3;- Specified by:
getDescriptionBytesin interfaceMetricMetadataOrBuilder- 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:
getDeprecatedApiNamesListin interfaceMetricMetadataOrBuilder- 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:
getDeprecatedApiNamesCountin interfaceMetricMetadataOrBuilder- Returns:
- The count of deprecatedApiNames.
-
getDeprecatedApiNames
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:
getDeprecatedApiNamesin interfaceMetricMetadataOrBuilder- 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:
getDeprecatedApiNamesBytesin interfaceMetricMetadataOrBuilder- 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:
getTypeValuein interfaceMetricMetadataOrBuilder- Returns:
- The enum numeric value on the wire for type.
-
getType
The type of this metric.
.google.analytics.data.v1beta.MetricType type = 5;- Specified by:
getTypein interfaceMetricMetadataOrBuilder- Returns:
- The type.
-
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:
getExpressionin interfaceMetricMetadataOrBuilder- 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:
getExpressionBytesin interfaceMetricMetadataOrBuilder- 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:
getCustomDefinitionin interfaceMetricMetadataOrBuilder- Returns:
- The customDefinition.
-
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:
getBlockedReasonsListin interfaceMetricMetadataOrBuilder- 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:
getBlockedReasonsCountin interfaceMetricMetadataOrBuilder- Returns:
- The count of blockedReasons.
-
getBlockedReasons
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:
getBlockedReasonsin interfaceMetricMetadataOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The blockedReasons at the given index.
-
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:
getBlockedReasonsValueListin interfaceMetricMetadataOrBuilder- 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:
getBlockedReasonsValuein interfaceMetricMetadataOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The enum numeric value on the wire of blockedReasons at the given index.
-
getCategory
The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.
string category = 10;- Specified by:
getCategoryin interfaceMetricMetadataOrBuilder- 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:
getCategoryBytesin interfaceMetricMetadataOrBuilder- Returns:
- The bytes for category.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- Throws:
IOException
-
parseFrom
public static MetricMetadata parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- 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
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected MetricMetadata.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-