Package com.google.analytics.data.v1alpha

Class DimensionMetadata

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.analytics.data.v1alpha.DimensionMetadata
All Implemented Interfaces:
DimensionMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class DimensionMetadata extends com.google.protobuf.GeneratedMessage implements DimensionMetadataOrBuilder
 Explains a dimension.
Protobuf type google.analytics.data.v1alpha.DimensionMetadata
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    DimensionMetadata.Builder
    Explains a dimension.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    API_NAME_FIELD_NUMBER
     
    static final int
    CATEGORY_FIELD_NUMBER
     
    static final int
    CUSTOM_DEFINITION_FIELD_NUMBER
     
    static final int
    DEPRECATED_API_NAMES_FIELD_NUMBER
     
    static final int
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    SECTIONS_FIELD_NUMBER
     
    static final int
    UI_NAME_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    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 custom to this property.
    static DimensionMetadata
    getDefaultInstance()
     
    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 final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<DimensionMetadata>
    getParserForType()
     
    Section
    getSections(int index)
    Specifies the Google Analytics sections this dimension applies to.
    int
    getSectionsCount()
    Specifies the Google Analytics sections this dimension applies to.
    List<Section>
    getSectionsList()
    Specifies the Google Analytics sections this dimension applies to.
    int
    getSectionsValue(int index)
    Specifies the Google Analytics sections this dimension applies to.
    List<Integer>
    getSectionsValueList()
    Specifies the Google Analytics sections this dimension applies to.
    int
    getSerializedSize()
     
    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.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static DimensionMetadata.Builder
    newBuilder()
     
    static DimensionMetadata.Builder
    newBuilder(DimensionMetadata prototype)
     
    DimensionMetadata.Builder
    newBuilderForType()
     
    protected DimensionMetadata.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static DimensionMetadata
    parseDelimitedFrom(InputStream input)
     
    static DimensionMetadata
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DimensionMetadata
    parseFrom(byte[] data)
     
    static DimensionMetadata
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DimensionMetadata
    parseFrom(com.google.protobuf.ByteString data)
     
    static DimensionMetadata
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DimensionMetadata
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static DimensionMetadata
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DimensionMetadata
    parseFrom(InputStream input)
     
    static DimensionMetadata
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DimensionMetadata
    parseFrom(ByteBuffer data)
     
    static DimensionMetadata
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<DimensionMetadata>
    parser()
     
    DimensionMetadata.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • API_NAME_FIELD_NUMBER

      public static final int API_NAME_FIELD_NUMBER
      See Also:

    • UI_NAME_FIELD_NUMBER

      public static final int UI_NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • DEPRECATED_API_NAMES_FIELD_NUMBER

      public static final int DEPRECATED_API_NAMES_FIELD_NUMBER
      See Also:

    • CUSTOM_DEFINITION_FIELD_NUMBER

      public static final int CUSTOM_DEFINITION_FIELD_NUMBER
      See Also:

    • CATEGORY_FIELD_NUMBER

      public static final int CATEGORY_FIELD_NUMBER
      See Also:

    • SECTIONS_FIELD_NUMBER

      public static final int SECTIONS_FIELD_NUMBER
      See Also:

  • 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

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static DimensionMetadata parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DimensionMetadata parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DimensionMetadata parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DimensionMetadata parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DimensionMetadata parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DimensionMetadata parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DimensionMetadata parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DimensionMetadata parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DimensionMetadata parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DimensionMetadata parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DimensionMetadata parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DimensionMetadata parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public DimensionMetadata.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static DimensionMetadata.Builder newBuilder()

    • newBuilder

      public static DimensionMetadata.Builder newBuilder(DimensionMetadata prototype)

    • toBuilder

      public DimensionMetadata.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected DimensionMetadata.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static DimensionMetadata getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<DimensionMetadata> parser()

    • getParserForType

      public com.google.protobuf.Parser<DimensionMetadata> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public DimensionMetadata getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder