com.google.analytics.data.v1beta

Class DimensionMetadata.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<DimensionMetadata.Builder>

com.google.analytics.data.v1beta.DimensionMetadata.Builder

All Implemented Interfaces:

DimensionMetadataOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

DimensionMetadata

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

 Explains a dimension.
 

Protobuf type google.analytics.data.v1beta.DimensionMetadata

Method Summary

Modifier and Type	Method and Description
DimensionMetadata.Builder	addAllDeprecatedApiNames(Iterable<String> values) Still usable but deprecated names for this dimension.
DimensionMetadata.Builder	addDeprecatedApiNames(String value) Still usable but deprecated names for this dimension.
DimensionMetadata.Builder	addDeprecatedApiNamesBytes(com.google.protobuf.ByteString value) Still usable but deprecated names for this dimension.
DimensionMetadata.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
DimensionMetadata	build()
DimensionMetadata	buildPartial()
DimensionMetadata.Builder	clear()
DimensionMetadata.Builder	clearApiName() This dimension's name.
DimensionMetadata.Builder	clearCategory() The display name of the category that this dimension belongs to.
DimensionMetadata.Builder	clearCustomDefinition() True if the dimension is a custom dimension for this property.
DimensionMetadata.Builder	clearDeprecatedApiNames() Still usable but deprecated names for this dimension.
DimensionMetadata.Builder	clearDescription() Description of how this dimension is used and calculated.
DimensionMetadata.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
DimensionMetadata.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
DimensionMetadata.Builder	clearUiName() This dimension's name within the Google Analytics user interface.
DimensionMetadata.Builder	clone()
String	getApiName() This dimension's name.
com.google.protobuf.ByteString	getApiNameBytes() This dimension's name.
String	getCategory() The display name of the category that this dimension belongs to.
com.google.protobuf.ByteString	getCategoryBytes() The display name of the category that this dimension belongs to.
boolean	getCustomDefinition() True if the dimension is a custom dimension for this property.
DimensionMetadata	getDefaultInstanceForType()
String	getDeprecatedApiNames(int index) Still usable but deprecated names for this dimension.
com.google.protobuf.ByteString	getDeprecatedApiNamesBytes(int index) Still usable but deprecated names for this dimension.
int	getDeprecatedApiNamesCount() Still usable but deprecated names for this dimension.
com.google.protobuf.ProtocolStringList	getDeprecatedApiNamesList() Still usable but deprecated names for this dimension.
String	getDescription() Description of how this dimension is used and calculated.
com.google.protobuf.ByteString	getDescriptionBytes() Description of how this dimension is used and calculated.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getUiName() This dimension's name within the Google Analytics user interface.
com.google.protobuf.ByteString	getUiNameBytes() This dimension's name within the Google Analytics user interface.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
DimensionMetadata.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
DimensionMetadata.Builder	mergeFrom(DimensionMetadata other)
DimensionMetadata.Builder	mergeFrom(com.google.protobuf.Message other)
DimensionMetadata.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
DimensionMetadata.Builder	setApiName(String value) This dimension's name.
DimensionMetadata.Builder	setApiNameBytes(com.google.protobuf.ByteString value) This dimension's name.
DimensionMetadata.Builder	setCategory(String value) The display name of the category that this dimension belongs to.
DimensionMetadata.Builder	setCategoryBytes(com.google.protobuf.ByteString value) The display name of the category that this dimension belongs to.
DimensionMetadata.Builder	setCustomDefinition(boolean value) True if the dimension is a custom dimension for this property.
DimensionMetadata.Builder	setDeprecatedApiNames(int index, String value) Still usable but deprecated names for this dimension.
DimensionMetadata.Builder	setDescription(String value) Description of how this dimension is used and calculated.
DimensionMetadata.Builder	setDescriptionBytes(com.google.protobuf.ByteString value) Description of how this dimension is used and calculated.
DimensionMetadata.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
DimensionMetadata.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
DimensionMetadata.Builder	setUiName(String value) This dimension's name within the Google Analytics user interface.
DimensionMetadata.Builder	setUiNameBytes(com.google.protobuf.ByteString value) This dimension's name within the Google Analytics user interface.
DimensionMetadata.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<DimensionMetadata.Builder>

clear

public DimensionMetadata.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<DimensionMetadata.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<DimensionMetadata.Builder>

getDefaultInstanceForType

public DimensionMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public DimensionMetadata build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public DimensionMetadata buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public DimensionMetadata.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<DimensionMetadata.Builder>

setField

public DimensionMetadata.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<DimensionMetadata.Builder>

clearField

public DimensionMetadata.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<DimensionMetadata.Builder>

clearOneof

public DimensionMetadata.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<DimensionMetadata.Builder>

setRepeatedField

public DimensionMetadata.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  int index,
                                                  Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DimensionMetadata.Builder>

addRepeatedField

public DimensionMetadata.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DimensionMetadata.Builder>

mergeFrom

public DimensionMetadata.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DimensionMetadata.Builder>

mergeFrom

public DimensionMetadata.Builder mergeFrom(DimensionMetadata other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<DimensionMetadata.Builder>

mergeFrom

public DimensionMetadata.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DimensionMetadata.Builder>

Throws:

IOException

getApiName

public String getApiName()

 This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For
 example, `eventName`.
 

string api_name = 1;

Specified by:

getApiName in interface DimensionMetadataOrBuilder

Returns:

The apiName.

getApiNameBytes

public com.google.protobuf.ByteString getApiNameBytes()

 This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For
 example, `eventName`.
 

string api_name = 1;

Specified by:

getApiNameBytes in interface DimensionMetadataOrBuilder

Returns:

The bytes for apiName.

setApiName

public DimensionMetadata.Builder setApiName(String value)

 This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For
 example, `eventName`.
 

string api_name = 1;

Parameters:

value - The apiName to set.

Returns:

This builder for chaining.

clearApiName

public DimensionMetadata.Builder clearApiName()

 This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For
 example, `eventName`.
 

string api_name = 1;

Returns:

This builder for chaining.

setApiNameBytes

public DimensionMetadata.Builder setApiNameBytes(com.google.protobuf.ByteString value)

 This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For
 example, `eventName`.
 

string api_name = 1;

Parameters:

value - The bytes for apiName to set.

Returns:

This builder for chaining.

getUiName

public String getUiName()

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

string ui_name = 2;

Specified by:

getUiName in interface DimensionMetadataOrBuilder

Returns:

The uiName.

getUiNameBytes

public com.google.protobuf.ByteString getUiNameBytes()

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

string ui_name = 2;

Specified by:

getUiNameBytes in interface DimensionMetadataOrBuilder

Returns:

The bytes for uiName.

setUiName

public DimensionMetadata.Builder setUiName(String value)

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

string ui_name = 2;

Parameters:

value - The uiName to set.

Returns:

This builder for chaining.

clearUiName

public DimensionMetadata.Builder clearUiName()

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

string ui_name = 2;

Returns:

This builder for chaining.

setUiNameBytes

public DimensionMetadata.Builder setUiNameBytes(com.google.protobuf.ByteString value)

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

string ui_name = 2;

Parameters:

value - The bytes for uiName to set.

Returns:

This builder for chaining.

getDescription

public String getDescription()

 Description of how this dimension is used and calculated.
 

string description = 3;

Specified by:

getDescription in interface DimensionMetadataOrBuilder

Returns:

The description.

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

 Description of how this dimension is used and calculated.
 

string description = 3;

Specified by:

getDescriptionBytes in interface DimensionMetadataOrBuilder

Returns:

The bytes for description.

setDescription

public DimensionMetadata.Builder setDescription(String value)

 Description of how this dimension is used and calculated.
 

string description = 3;

Parameters:

value - The description to set.

Returns:

This builder for chaining.

clearDescription

public DimensionMetadata.Builder clearDescription()

 Description of how this dimension is used and calculated.
 

string description = 3;

Returns:

This builder for chaining.

setDescriptionBytes

public DimensionMetadata.Builder setDescriptionBytes(com.google.protobuf.ByteString value)

 Description of how this dimension is used and calculated.
 

string description = 3;

Parameters:

value - The bytes for description to set.

Returns:

This builder for chaining.

getDeprecatedApiNamesList

public com.google.protobuf.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;

Specified by:

getDeprecatedApiNamesList in interface DimensionMetadataOrBuilder

Returns:

A list containing the deprecatedApiNames.

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;

Specified by:

getDeprecatedApiNamesCount in interface DimensionMetadataOrBuilder

Returns:

The count of deprecatedApiNames.

getDeprecatedApiNames

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;

Specified by:

getDeprecatedApiNames in interface DimensionMetadataOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The deprecatedApiNames at the given index.

getDeprecatedApiNamesBytes

public com.google.protobuf.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;

Specified by:

getDeprecatedApiNamesBytes in interface DimensionMetadataOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the deprecatedApiNames at the given index.

setDeprecatedApiNames

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:

index - The index to set the value at.

value - The deprecatedApiNames to set.

Returns:

This builder for chaining.

addDeprecatedApiNames

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;

Parameters:

value - The deprecatedApiNames to add.

Returns:

This builder for chaining.

addAllDeprecatedApiNames

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;

Parameters:

values - The deprecatedApiNames to add.

Returns:

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:

This builder for chaining.

addDeprecatedApiNamesBytes

public DimensionMetadata.Builder addDeprecatedApiNamesBytes(com.google.protobuf.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;

Parameters:

value - The bytes of the deprecatedApiNames to add.

Returns:

This builder for chaining.

getCustomDefinition

public boolean getCustomDefinition()

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

bool custom_definition = 5;

Specified by:

getCustomDefinition in interface DimensionMetadataOrBuilder

Returns:

The customDefinition.

setCustomDefinition

public DimensionMetadata.Builder setCustomDefinition(boolean value)

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

bool custom_definition = 5;

Parameters:

value - The customDefinition to set.

Returns:

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:

This builder for chaining.

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;

Specified by:

getCategory in interface DimensionMetadataOrBuilder

Returns:

The category.

getCategoryBytes

public com.google.protobuf.ByteString getCategoryBytes()

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

string category = 7;

Specified by:

getCategoryBytes in interface DimensionMetadataOrBuilder

Returns:

The bytes for category.

setCategory

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;

Parameters:

value - The category to set.

Returns:

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:

This builder for chaining.

setCategoryBytes

public DimensionMetadata.Builder setCategoryBytes(com.google.protobuf.ByteString value)

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

string category = 7;

Parameters:

value - The bytes for category to set.

Returns:

This builder for chaining.

setUnknownFields

public final DimensionMetadata.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DimensionMetadata.Builder>

mergeUnknownFields

public final DimensionMetadata.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DimensionMetadata.Builder>