Class MetricMetadata (0.63.0) 

public final class MetricMetadata extends GeneratedMessageV3 implements MetricMetadataOrBuilder

Explains a metric.

Protobuf type google.analytics.data.v1beta.MetricMetadata

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > MetricMetadata

Static Fields

API_NAME_FIELD_NUMBER

public static final int API_NAME_FIELD_NUMBER
Field Value
Type Description
int

BLOCKED_REASONS_FIELD_NUMBER

public static final int BLOCKED_REASONS_FIELD_NUMBER
Field Value
Type Description
int

CATEGORY_FIELD_NUMBER

public static final int CATEGORY_FIELD_NUMBER
Field Value
Type Description
int

CUSTOM_DEFINITION_FIELD_NUMBER

public static final int CUSTOM_DEFINITION_FIELD_NUMBER
Field Value
Type Description
int

DEPRECATED_API_NAMES_FIELD_NUMBER

public static final int DEPRECATED_API_NAMES_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

EXPRESSION_FIELD_NUMBER

public static final int EXPRESSION_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

UI_NAME_FIELD_NUMBER

public static final int UI_NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MetricMetadata getDefaultInstance()
Returns
Type Description
MetricMetadata

getDescriptor()

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

newBuilder()

public static MetricMetadata.Builder newBuilder()
Returns
Type Description
MetricMetadata.Builder

newBuilder(MetricMetadata prototype)

public static MetricMetadata.Builder newBuilder(MetricMetadata prototype)
Parameter
Name Description
prototype MetricMetadata
Returns
Type Description
MetricMetadata.Builder

parseDelimitedFrom(InputStream input)

public static MetricMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MetricMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MetricMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static MetricMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
MetricMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MetricMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MetricMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
MetricMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MetricMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MetricMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
MetricMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MetricMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static MetricMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MetricMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MetricMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static MetricMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
MetricMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MetricMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<MetricMetadata> parser()
Returns
Type Description
Parser<MetricMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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.

getParserForType()

public Parser<MetricMetadata> getParserForType()
Returns
Type Description
Parser<MetricMetadata>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public MetricMetadata.Builder newBuilderForType()
Returns
Type Description
MetricMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MetricMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MetricMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public MetricMetadata.Builder toBuilder()
Returns
Type Description
MetricMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException