Package com.google.analytics.data.v1alpha

Class DimensionMetadata.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<DimensionMetadata.Builder>
com.google.analytics.data.v1alpha.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.GeneratedMessage.Builder<DimensionMetadata.Builder> implements DimensionMetadataOrBuilder
 Explains a dimension.
Protobuf type google.analytics.data.v1alpha.DimensionMetadata

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.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

    • 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.GeneratedMessage.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. Usable 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. Usable 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. Usable 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. Usable 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. Usable 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 custom to this property. This includes user,
 event, & item scoped custom dimensions; to learn more about custom
 dimensions, see https://support.google.com/analytics/answer/14240153. This
 also include custom channel groups; to learn more about custom channel
 groups, see https://support.google.com/analytics/answer/13051316.
      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 custom to this property. This includes user,
 event, & item scoped custom dimensions; to learn more about custom
 dimensions, see https://support.google.com/analytics/answer/14240153. This
 also include custom channel groups; to learn more about custom channel
 groups, see https://support.google.com/analytics/answer/13051316.
      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 custom to this property. This includes user,
 event, & item scoped custom dimensions; to learn more about custom
 dimensions, see https://support.google.com/analytics/answer/14240153. This
 also include custom channel groups; to learn more about custom channel
 groups, see https://support.google.com/analytics/answer/13051316.
      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 = 6;
      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 = 6;
      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 = 6;
      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 = 6;
      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 = 6;
      Parameters:
      value - The bytes for category to set.
      Returns:
      This builder for chaining.

    • getSectionsList

      public List<Section> getSectionsList()
       Specifies the Google Analytics sections this dimension applies to.
      repeated .google.analytics.data.v1alpha.Section sections = 7;
      Specified by:
      getSectionsList in interface DimensionMetadataOrBuilder
      Returns:
      A list containing the sections.

    • getSectionsCount

      public int getSectionsCount()
       Specifies the Google Analytics sections this dimension applies to.
      repeated .google.analytics.data.v1alpha.Section sections = 7;
      Specified by:
      getSectionsCount in interface DimensionMetadataOrBuilder
      Returns:
      The count of sections.

    • getSections

      public Section getSections(int index)
       Specifies the Google Analytics sections this dimension applies to.
      repeated .google.analytics.data.v1alpha.Section sections = 7;
      Specified by:
      getSections in interface DimensionMetadataOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The sections at the given index.

    • setSections

      public DimensionMetadata.Builder setSections(int index, Section value)
       Specifies the Google Analytics sections this dimension applies to.
      repeated .google.analytics.data.v1alpha.Section sections = 7;
      Parameters:
      index - The index to set the value at.
      value - The sections to set.
      Returns:
      This builder for chaining.

    • addSections

      public DimensionMetadata.Builder addSections(Section value)
       Specifies the Google Analytics sections this dimension applies to.
      repeated .google.analytics.data.v1alpha.Section sections = 7;
      Parameters:
      value - The sections to add.
      Returns:
      This builder for chaining.

    • addAllSections

      public DimensionMetadata.Builder addAllSections(Iterable<? extends Section> values)
       Specifies the Google Analytics sections this dimension applies to.
      repeated .google.analytics.data.v1alpha.Section sections = 7;
      Parameters:
      values - The sections to add.
      Returns:
      This builder for chaining.

    • clearSections

      public DimensionMetadata.Builder clearSections()
       Specifies the Google Analytics sections this dimension applies to.
      repeated .google.analytics.data.v1alpha.Section sections = 7;
      Returns:
      This builder for chaining.

    • getSectionsValueList

      public List<Integer> getSectionsValueList()
       Specifies the Google Analytics sections this dimension applies to.
      repeated .google.analytics.data.v1alpha.Section sections = 7;
      Specified by:
      getSectionsValueList in interface DimensionMetadataOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for sections.

    • getSectionsValue

      public int getSectionsValue(int index)
       Specifies the Google Analytics sections this dimension applies to.
      repeated .google.analytics.data.v1alpha.Section sections = 7;
      Specified by:
      getSectionsValue in interface DimensionMetadataOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of sections at the given index.

    • setSectionsValue

      public DimensionMetadata.Builder setSectionsValue(int index, int value)
       Specifies the Google Analytics sections this dimension applies to.
      repeated .google.analytics.data.v1alpha.Section sections = 7;
      Parameters:
      index - The index to set the value at.
      value - The enum numeric value on the wire for sections to set.
      Returns:
      This builder for chaining.

    • addSectionsValue

      public DimensionMetadata.Builder addSectionsValue(int value)
       Specifies the Google Analytics sections this dimension applies to.
      repeated .google.analytics.data.v1alpha.Section sections = 7;
      Parameters:
      value - The enum numeric value on the wire for sections to add.
      Returns:
      This builder for chaining.

    • addAllSectionsValue

      public DimensionMetadata.Builder addAllSectionsValue(Iterable<Integer> values)
       Specifies the Google Analytics sections this dimension applies to.
      repeated .google.analytics.data.v1alpha.Section sections = 7;
      Parameters:
      values - The enum numeric values on the wire for sections to add.
      Returns:
      This builder for chaining.