Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Interface DimensionMetadataOrBuilder (0.39.0)

public interface DimensionMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getApiName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean getCustomDefinition()

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

bool custom_definition = 5;

Returns
Type	Description
`boolean`	The customDefinition.

getDeprecatedApiNames(int index)

public abstract 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 abstract ByteString getDeprecatedApiNamesBytes(int index)

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 abstract int getDeprecatedApiNamesCount()

repeated string deprecated_api_names = 4;

Returns
Type	Description
`int`	The count of deprecatedApiNames.

getDeprecatedApiNamesList()

public abstract List<String> getDeprecatedApiNamesList()

repeated string deprecated_api_names = 4;

Returns
Type	Description
`List<String>`	A list containing the deprecatedApiNames.

getDescription()

public abstract String getDescription()

Description of how this dimension is used and calculated.

string description = 3;

Returns
Type	Description
`String`	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Description of how this dimension is used and calculated.

string description = 3;

Returns
Type	Description
`ByteString`	The bytes for description.

getUiName()

public abstract 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 abstract 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.