public final class DimensionMetadata extends GeneratedMessageV3 implements DimensionMetadataOrBuilder
Explains a dimension.
Protobuf type google.analytics.data.v1beta.DimensionMetadata
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int API_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int CATEGORY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int CUSTOM_DEFINITION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DEPRECATED_API_NAMES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int UI_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static DimensionMetadata getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static DimensionMetadata.Builder newBuilder()
public static DimensionMetadata.Builder newBuilder(DimensionMetadata prototype)
public static DimensionMetadata parseDelimitedFrom(InputStream input)
public static DimensionMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static DimensionMetadata parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static DimensionMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DimensionMetadata parseFrom(ByteString data)
public static DimensionMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DimensionMetadata parseFrom(CodedInputStream input)
public static DimensionMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DimensionMetadata parseFrom(InputStream input)
public static DimensionMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static DimensionMetadata parseFrom(ByteBuffer data)
public static DimensionMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<DimensionMetadata> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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.
|
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.
|
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.
|
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.
|
public boolean getCustomDefinition()
True if the dimension is a custom dimension for this property.
bool custom_definition = 5;
| Returns |
| Type |
Description |
boolean |
The customDefinition.
|
public DimensionMetadata getDefaultInstanceForType()
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.
|
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.
|
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.
|
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;
public String getDescription()
Description of how this dimension is used and calculated.
string description = 3;
| Returns |
| Type |
Description |
String |
The description.
|
public ByteString getDescriptionBytes()
Description of how this dimension is used and calculated.
string description = 3;
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
public Parser<DimensionMetadata> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public DimensionMetadata.Builder newBuilderForType()
protected DimensionMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public DimensionMetadata.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
