Class DimensionMetadata (0.22.0)

Version 0.22.0

• 0.63.0 (latest)
• 0.62.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0

public final class DimensionMetadata extends GeneratedMessageV3 implements DimensionMetadataOrBuilder

Explains a dimension.

Protobuf type google.analytics.data.v1beta.DimensionMetadata

Inheritance

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

Implements

DimensionMetadataOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

API_NAME_FIELD_NUMBER

public static final int API_NAME_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

UI_NAME_FIELD_NUMBER

public static final int UI_NAME_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static DimensionMetadata getDefaultInstance()

Returns

Type	Description
DimensionMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static DimensionMetadata.Builder newBuilder()

Returns

Type	Description
DimensionMetadata.Builder

newBuilder(DimensionMetadata prototype)

public static DimensionMetadata.Builder newBuilder(DimensionMetadata prototype)

Parameter

Name	Description
prototype	DimensionMetadata

Returns

Type	Description
DimensionMetadata.Builder

parseDelimitedFrom(InputStream input)

public static DimensionMetadata parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
DimensionMetadata

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DimensionMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
DimensionMetadata

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static DimensionMetadata parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
DimensionMetadata

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DimensionMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
DimensionMetadata

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DimensionMetadata parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
DimensionMetadata

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DimensionMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
DimensionMetadata

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DimensionMetadata parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
DimensionMetadata

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DimensionMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
DimensionMetadata

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static DimensionMetadata parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
DimensionMetadata

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DimensionMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
DimensionMetadata

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static DimensionMetadata parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
DimensionMetadata

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DimensionMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
DimensionMetadata

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<DimensionMetadata> parser()

Returns

Type	Description
Parser<DimensionMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getApiName()

public String getApiName()

This dimension's name. Useable in Dimension's name. For example, eventName.

string api_name = 1;

Returns

Type	Description
String	The apiName.

getApiNameBytes()

public ByteString getApiNameBytes()

This dimension's name. Useable in Dimension's name. For example, eventName.

string api_name = 1;

Returns

Type	Description
ByteString	The bytes for apiName.

getCategory()

public String getCategory()

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

string category = 7;

Returns

Type	Description
String	The category.

getCategoryBytes()

public ByteString getCategoryBytes()

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

string category = 7;

Returns

Type	Description
ByteString	The bytes for category.

getCustomDefinition()

public boolean getCustomDefinition()

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

bool custom_definition = 5;

Returns

Type	Description
boolean	The customDefinition.

getDefaultInstanceForType()

public DimensionMetadata getDefaultInstanceForType()

Returns

Type	Description
DimensionMetadata

getDeprecatedApiNames(int index)

public String getDeprecatedApiNames(int index)

Still usable but deprecated names for this dimension. If populated, this dimension is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the dimension 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 dimension. If populated, this dimension is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the dimension 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 dimension. If populated, this dimension is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the dimension 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 dimension. If populated, this dimension is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the dimension 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 dimension is used and calculated.

string description = 3;

Returns

Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of how this dimension is used and calculated.

string description = 3;

Returns

Type	Description
ByteString	The bytes for description.

getParserForType()

public Parser<DimensionMetadata> getParserForType()

Returns

Type	Description
Parser<DimensionMetadata>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUiName()

public String getUiName()

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

string ui_name = 2;

Returns

Type	Description
String	The uiName.

getUiNameBytes()

public ByteString getUiNameBytes()

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

string ui_name = 2;

Returns

Type	Description
ByteString	The bytes for uiName.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public DimensionMetadata.Builder newBuilderForType()

Returns

Type	Description
DimensionMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DimensionMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
DimensionMetadata.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public DimensionMetadata.Builder toBuilder()

Returns

Type	Description
DimensionMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException