Package com.google.analytics.admin.v1alpha

Class KeyEvent

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.analytics.admin.v1alpha.KeyEvent
All Implemented Interfaces:
KeyEventOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class KeyEvent extends com.google.protobuf.GeneratedMessage implements KeyEventOrBuilder
 A key event in a Google Analytics property.
Protobuf type google.analytics.admin.v1alpha.KeyEvent
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    KeyEvent.Builder
    A key event in a Google Analytics property.
    static enum 
    KeyEvent.CountingMethod
    The method by which Key Events will be counted across multiple events within a session.
    static final class 
    KeyEvent.DefaultValue
    Defines a default value/currency for a key event.
    static interface 
    KeyEvent.DefaultValueOrBuilder
     

    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
    COUNTING_METHOD_FIELD_NUMBER
     
    static final int
    CREATE_TIME_FIELD_NUMBER
     
    static final int
    CUSTOM_FIELD_NUMBER
     
    static final int
    DEFAULT_VALUE_FIELD_NUMBER
     
    static final int
    DELETABLE_FIELD_NUMBER
     
    static final int
    EVENT_NAME_FIELD_NUMBER
     
    static final int
    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)
     
    KeyEvent.CountingMethod
    getCountingMethod()
    Required.
    int
    getCountingMethodValue()
    Required.
    com.google.protobuf.Timestamp
    getCreateTime()
    Output only.
    com.google.protobuf.TimestampOrBuilder
    getCreateTimeOrBuilder()
    Output only.
    boolean
    getCustom()
    Output only.
    static KeyEvent
    getDefaultInstance()
     
    KeyEvent
    getDefaultInstanceForType()
     
    KeyEvent.DefaultValue
    getDefaultValue()
    Optional.
    KeyEvent.DefaultValueOrBuilder
    getDefaultValueOrBuilder()
    Optional.
    boolean
    getDeletable()
    Output only.
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getEventName()
    Immutable.
    com.google.protobuf.ByteString
    getEventNameBytes()
    Immutable.
    String
    getName()
    Output only.
    com.google.protobuf.ByteString
    getNameBytes()
    Output only.
    com.google.protobuf.Parser<KeyEvent>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasCreateTime()
    Output only.
    boolean
    hasDefaultValue()
    Optional.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static KeyEvent.Builder
    newBuilder()
     
    static KeyEvent.Builder
    newBuilder(KeyEvent prototype)
     
    KeyEvent.Builder
    newBuilderForType()
     
    protected KeyEvent.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static KeyEvent
    parseDelimitedFrom(InputStream input)
     
    static KeyEvent
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeyEvent
    parseFrom(byte[] data)
     
    static KeyEvent
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeyEvent
    parseFrom(com.google.protobuf.ByteString data)
     
    static KeyEvent
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeyEvent
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static KeyEvent
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeyEvent
    parseFrom(InputStream input)
     
    static KeyEvent
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeyEvent
    parseFrom(ByteBuffer data)
     
    static KeyEvent
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<KeyEvent>
    parser()
     
    KeyEvent.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

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • EVENT_NAME_FIELD_NUMBER

      public static final int EVENT_NAME_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • DELETABLE_FIELD_NUMBER

      public static final int DELETABLE_FIELD_NUMBER
      See Also:

    • CUSTOM_FIELD_NUMBER

      public static final int CUSTOM_FIELD_NUMBER
      See Also:

    • COUNTING_METHOD_FIELD_NUMBER

      public static final int COUNTING_METHOD_FIELD_NUMBER
      See Also:

    • DEFAULT_VALUE_FIELD_NUMBER

      public static final int DEFAULT_VALUE_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

    • getName

      public String getName()
       Output only. Resource name of this key event.
 Format: properties/{property}/keyEvents/{key_event}
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getName in interface KeyEventOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. Resource name of this key event.
 Format: properties/{property}/keyEvents/{key_event}
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNameBytes in interface KeyEventOrBuilder
      Returns:
      The bytes for name.

    • getEventName

      public String getEventName()
       Immutable. The event name for this key event.
 Examples: 'click', 'purchase'
      string event_name = 2 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getEventName in interface KeyEventOrBuilder
      Returns:
      The eventName.

    • getEventNameBytes

      public com.google.protobuf.ByteString getEventNameBytes()
       Immutable. The event name for this key event.
 Examples: 'click', 'purchase'
      string event_name = 2 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getEventNameBytes in interface KeyEventOrBuilder
      Returns:
      The bytes for eventName.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Time when this key event was created in the property.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface KeyEventOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. Time when this key event was created in the property.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface KeyEventOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Time when this key event was created in the property.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface KeyEventOrBuilder

    • getDeletable

      public boolean getDeletable()
       Output only. If set to true, this event can be deleted.
      bool deletable = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDeletable in interface KeyEventOrBuilder
      Returns:
      The deletable.

    • getCustom

      public boolean getCustom()
       Output only. If set to true, this key event refers to a custom event.  If
 set to false, this key event refers to a default event in GA. Default
 events typically have special meaning in GA. Default events are usually
 created for you by the GA system, but in some cases can be created by
 property admins. Custom events count towards the maximum number of
 custom key events that may be created per property.
      bool custom = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCustom in interface KeyEventOrBuilder
      Returns:
      The custom.

    • getCountingMethodValue

      public int getCountingMethodValue()
       Required. The method by which Key Events will be counted across multiple
 events within a session.
      .google.analytics.admin.v1alpha.KeyEvent.CountingMethod counting_method = 6 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCountingMethodValue in interface KeyEventOrBuilder
      Returns:
      The enum numeric value on the wire for countingMethod.

    • getCountingMethod

      public KeyEvent.CountingMethod getCountingMethod()
       Required. The method by which Key Events will be counted across multiple
 events within a session.
      .google.analytics.admin.v1alpha.KeyEvent.CountingMethod counting_method = 6 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCountingMethod in interface KeyEventOrBuilder
      Returns:
      The countingMethod.

    • hasDefaultValue

      public boolean hasDefaultValue()
       Optional. Defines a default value/currency for a key event.
      .google.analytics.admin.v1alpha.KeyEvent.DefaultValue default_value = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasDefaultValue in interface KeyEventOrBuilder
      Returns:
      Whether the defaultValue field is set.

    • getDefaultValue

      public KeyEvent.DefaultValue getDefaultValue()
       Optional. Defines a default value/currency for a key event.
      .google.analytics.admin.v1alpha.KeyEvent.DefaultValue default_value = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDefaultValue in interface KeyEventOrBuilder
      Returns:
      The defaultValue.

    • getDefaultValueOrBuilder

      public KeyEvent.DefaultValueOrBuilder getDefaultValueOrBuilder()
       Optional. Defines a default value/currency for a key event.
      .google.analytics.admin.v1alpha.KeyEvent.DefaultValue default_value = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDefaultValueOrBuilder in interface KeyEventOrBuilder

    • 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 KeyEvent parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static KeyEvent.Builder newBuilder()

    • newBuilder

      public static KeyEvent.Builder newBuilder(KeyEvent prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static KeyEvent getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<KeyEvent> 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 KeyEvent getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder