Class DimensionMetadata.Builder (0.22.0)

public static final class DimensionMetadata.Builder extends GeneratedMessageV3.Builder<DimensionMetadata.Builder> implements DimensionMetadataOrBuilder

Explains a dimension.

Protobuf type google.analytics.data.v1beta.DimensionMetadata

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllDeprecatedApiNames(Iterable<String> values)

public DimensionMetadata.Builder addAllDeprecatedApiNames(Iterable<String> values)

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
NameDescription
valuesIterable<String>

The deprecatedApiNames to add.

Returns
TypeDescription
DimensionMetadata.Builder

This builder for chaining.

addDeprecatedApiNames(String value)

public DimensionMetadata.Builder addDeprecatedApiNames(String value)

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
NameDescription
valueString

The deprecatedApiNames to add.

Returns
TypeDescription
DimensionMetadata.Builder

This builder for chaining.

addDeprecatedApiNamesBytes(ByteString value)

public DimensionMetadata.Builder addDeprecatedApiNamesBytes(ByteString value)

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
NameDescription
valueByteString

The bytes of the deprecatedApiNames to add.

Returns
TypeDescription
DimensionMetadata.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DimensionMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DimensionMetadata.Builder
Overrides

build()

public DimensionMetadata build()
Returns
TypeDescription
DimensionMetadata

buildPartial()

public DimensionMetadata buildPartial()
Returns
TypeDescription
DimensionMetadata

clear()

public DimensionMetadata.Builder clear()
Returns
TypeDescription
DimensionMetadata.Builder
Overrides

clearApiName()

public DimensionMetadata.Builder clearApiName()

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

string api_name = 1;

Returns
TypeDescription
DimensionMetadata.Builder

This builder for chaining.

clearCategory()

public DimensionMetadata.Builder clearCategory()

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

string category = 7;

Returns
TypeDescription
DimensionMetadata.Builder

This builder for chaining.

clearCustomDefinition()

public DimensionMetadata.Builder clearCustomDefinition()

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

bool custom_definition = 5;

Returns
TypeDescription
DimensionMetadata.Builder

This builder for chaining.

clearDeprecatedApiNames()

public DimensionMetadata.Builder clearDeprecatedApiNames()

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
TypeDescription
DimensionMetadata.Builder

This builder for chaining.

clearDescription()

public DimensionMetadata.Builder clearDescription()

Description of how this dimension is used and calculated.

string description = 3;

Returns
TypeDescription
DimensionMetadata.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DimensionMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
DimensionMetadata.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public DimensionMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
DimensionMetadata.Builder
Overrides

clearUiName()

public DimensionMetadata.Builder clearUiName()

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

string ui_name = 2;

Returns
TypeDescription
DimensionMetadata.Builder

This builder for chaining.

clone()

public DimensionMetadata.Builder clone()
Returns
TypeDescription
DimensionMetadata.Builder
Overrides

getApiName()

public String getApiName()

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

string api_name = 1;

Returns
TypeDescription
String

The apiName.

getApiNameBytes()

public ByteString getApiNameBytes()

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

string api_name = 1;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

The customDefinition.

getDefaultInstanceForType()

public DimensionMetadata getDefaultInstanceForType()
Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProtocolStringList

A list containing the deprecatedApiNames.

getDescription()

public String getDescription()

Description of how this dimension is used and calculated.

string description = 3;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of how this dimension is used and calculated.

string description = 3;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getUiName()

public String getUiName()

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

string ui_name = 2;

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for uiName.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(DimensionMetadata other)

public DimensionMetadata.Builder mergeFrom(DimensionMetadata other)
Parameter
NameDescription
otherDimensionMetadata
Returns
TypeDescription
DimensionMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DimensionMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DimensionMetadata.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public DimensionMetadata.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
DimensionMetadata.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DimensionMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DimensionMetadata.Builder
Overrides

setApiName(String value)

public DimensionMetadata.Builder setApiName(String value)

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

string api_name = 1;

Parameter
NameDescription
valueString

The apiName to set.

Returns
TypeDescription
DimensionMetadata.Builder

This builder for chaining.

setApiNameBytes(ByteString value)

public DimensionMetadata.Builder setApiNameBytes(ByteString value)

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

string api_name = 1;

Parameter
NameDescription
valueByteString

The bytes for apiName to set.

Returns
TypeDescription
DimensionMetadata.Builder

This builder for chaining.

setCategory(String value)

public DimensionMetadata.Builder setCategory(String value)

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

string category = 7;

Parameter
NameDescription
valueString

The category to set.

Returns
TypeDescription
DimensionMetadata.Builder

This builder for chaining.

setCategoryBytes(ByteString value)

public DimensionMetadata.Builder setCategoryBytes(ByteString value)

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

string category = 7;

Parameter
NameDescription
valueByteString

The bytes for category to set.

Returns
TypeDescription
DimensionMetadata.Builder

This builder for chaining.

setCustomDefinition(boolean value)

public DimensionMetadata.Builder setCustomDefinition(boolean value)

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

bool custom_definition = 5;

Parameter
NameDescription
valueboolean

The customDefinition to set.

Returns
TypeDescription
DimensionMetadata.Builder

This builder for chaining.

setDeprecatedApiNames(int index, String value)

public DimensionMetadata.Builder setDeprecatedApiNames(int index, String value)

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;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The deprecatedApiNames to set.

Returns
TypeDescription
DimensionMetadata.Builder

This builder for chaining.

setDescription(String value)

public DimensionMetadata.Builder setDescription(String value)

Description of how this dimension is used and calculated.

string description = 3;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
DimensionMetadata.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public DimensionMetadata.Builder setDescriptionBytes(ByteString value)

Description of how this dimension is used and calculated.

string description = 3;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
DimensionMetadata.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DimensionMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DimensionMetadata.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DimensionMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
DimensionMetadata.Builder
Overrides

setUiName(String value)

public DimensionMetadata.Builder setUiName(String value)

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

string ui_name = 2;

Parameter
NameDescription
valueString

The uiName to set.

Returns
TypeDescription
DimensionMetadata.Builder

This builder for chaining.

setUiNameBytes(ByteString value)

public DimensionMetadata.Builder setUiNameBytes(ByteString value)

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

string ui_name = 2;

Parameter
NameDescription
valueByteString

The bytes for uiName to set.

Returns
TypeDescription
DimensionMetadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DimensionMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DimensionMetadata.Builder
Overrides