Class KeyEvent (0.59.0)

public final class KeyEvent extends GeneratedMessageV3 implements KeyEventOrBuilder

A key event in a Google Analytics property.

Protobuf type google.analytics.admin.v1beta.KeyEvent

Implements

KeyEventOrBuilder

Static Fields

COUNTING_METHOD_FIELD_NUMBER

public static final int COUNTING_METHOD_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

CUSTOM_FIELD_NUMBER

public static final int CUSTOM_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_VALUE_FIELD_NUMBER

public static final int DEFAULT_VALUE_FIELD_NUMBER
Field Value
Type Description
int

DELETABLE_FIELD_NUMBER

public static final int DELETABLE_FIELD_NUMBER
Field Value
Type Description
int

EVENT_NAME_FIELD_NUMBER

public static final int EVENT_NAME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static KeyEvent getDefaultInstance()
Returns
Type Description
KeyEvent

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static KeyEvent.Builder newBuilder()
Returns
Type Description
KeyEvent.Builder

newBuilder(KeyEvent prototype)

public static KeyEvent.Builder newBuilder(KeyEvent prototype)
Parameter
Name Description
prototype KeyEvent
Returns
Type Description
KeyEvent.Builder

parseDelimitedFrom(InputStream input)

public static KeyEvent parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
KeyEvent
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KeyEvent parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KeyEvent
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static KeyEvent parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
KeyEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static KeyEvent parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KeyEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static KeyEvent parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
KeyEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static KeyEvent parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KeyEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static KeyEvent parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
KeyEvent
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static KeyEvent parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KeyEvent
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static KeyEvent parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
KeyEvent
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KeyEvent parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KeyEvent
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static KeyEvent parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
KeyEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static KeyEvent parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KeyEvent
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<KeyEvent> parser()
Returns
Type Description
Parser<KeyEvent>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCountingMethod()

public KeyEvent.CountingMethod getCountingMethod()

Required. The method by which Key Events will be counted across multiple events within a session.

.google.analytics.admin.v1beta.KeyEvent.CountingMethod counting_method = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
KeyEvent.CountingMethod

The countingMethod.

getCountingMethodValue()

public int getCountingMethodValue()

Required. The method by which Key Events will be counted across multiple events within a session.

.google.analytics.admin.v1beta.KeyEvent.CountingMethod counting_method = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for countingMethod.

getCreateTime()

public 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];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public 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];

Returns
Type Description
TimestampOrBuilder

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];

Returns
Type Description
boolean

The custom.

getDefaultInstanceForType()

public KeyEvent getDefaultInstanceForType()
Returns
Type Description
KeyEvent

getDefaultValue()

public KeyEvent.DefaultValue getDefaultValue()

Optional. Defines a default value/currency for a key event.

.google.analytics.admin.v1beta.KeyEvent.DefaultValue default_value = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
KeyEvent.DefaultValue

The defaultValue.

getDefaultValueOrBuilder()

public KeyEvent.DefaultValueOrBuilder getDefaultValueOrBuilder()

Optional. Defines a default value/currency for a key event.

.google.analytics.admin.v1beta.KeyEvent.DefaultValue default_value = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
KeyEvent.DefaultValueOrBuilder

getDeletable()

public boolean getDeletable()

Output only. If set to true, this event can be deleted.

bool deletable = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The deletable.

getEventName()

public String getEventName()

Immutable. The event name for this key event. Examples: 'click', 'purchase'

string event_name = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The eventName.

getEventNameBytes()

public ByteString getEventNameBytes()

Immutable. The event name for this key event. Examples: 'click', 'purchase'

string event_name = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for eventName.

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];

Returns
Type Description
String

The name.

getNameBytes()

public 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];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<KeyEvent> getParserForType()
Returns
Type Description
Parser<KeyEvent>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDefaultValue()

public boolean hasDefaultValue()

Optional. Defines a default value/currency for a key event.

.google.analytics.admin.v1beta.KeyEvent.DefaultValue default_value = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the defaultValue field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public KeyEvent.Builder newBuilderForType()
Returns
Type Description
KeyEvent.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected KeyEvent.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
KeyEvent.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public KeyEvent.Builder toBuilder()
Returns
Type Description
KeyEvent.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException