Class KeyEvent.Builder (0.63.0) 

public static final class KeyEvent.Builder extends GeneratedMessageV3.Builder<KeyEvent.Builder> implements KeyEventOrBuilder

A key event in a Google Analytics property.

Protobuf type google.analytics.admin.v1alpha.KeyEvent

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > KeyEvent.Builder

Implements

KeyEventOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public KeyEvent.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
KeyEvent.Builder
Overrides

build()

public KeyEvent build()
Returns
Type Description
KeyEvent

buildPartial()

public KeyEvent buildPartial()
Returns
Type Description
KeyEvent

clear()

public KeyEvent.Builder clear()
Returns
Type Description
KeyEvent.Builder
Overrides

clearCountingMethod()

public KeyEvent.Builder clearCountingMethod()

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

Returns
Type Description
KeyEvent.Builder

This builder for chaining.

clearCreateTime()

public KeyEvent.Builder clearCreateTime()

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
KeyEvent.Builder

clearCustom()

public KeyEvent.Builder clearCustom()

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
KeyEvent.Builder

This builder for chaining.

clearDefaultValue()

public KeyEvent.Builder clearDefaultValue()

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

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

Returns
Type Description
KeyEvent.Builder

clearDeletable()

public KeyEvent.Builder clearDeletable()

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

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

Returns
Type Description
KeyEvent.Builder

This builder for chaining.

clearEventName()

public KeyEvent.Builder clearEventName()

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

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

Returns
Type Description
KeyEvent.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public KeyEvent.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
KeyEvent.Builder
Overrides

clearName()

public KeyEvent.Builder clearName()

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
KeyEvent.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public KeyEvent.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
KeyEvent.Builder
Overrides

clone()

public KeyEvent.Builder clone()
Returns
Type Description
KeyEvent.Builder
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.v1alpha.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.v1alpha.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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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
Builder

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.v1alpha.KeyEvent.DefaultValue default_value = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
KeyEvent.DefaultValue

The defaultValue.

getDefaultValueBuilder()

public KeyEvent.DefaultValue.Builder getDefaultValueBuilder()

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

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

Returns
Type Description
KeyEvent.DefaultValue.Builder

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

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.v1alpha.KeyEvent.DefaultValue default_value = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the defaultValue field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public KeyEvent.Builder mergeCreateTime(Timestamp value)

Output only. Time when this key event was created in the property.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
KeyEvent.Builder

mergeDefaultValue(KeyEvent.DefaultValue value)

public KeyEvent.Builder mergeDefaultValue(KeyEvent.DefaultValue value)

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

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

Parameter
Name Description
value KeyEvent.DefaultValue
Returns
Type Description
KeyEvent.Builder

mergeFrom(KeyEvent other)

public KeyEvent.Builder mergeFrom(KeyEvent other)
Parameter
Name Description
other KeyEvent
Returns
Type Description
KeyEvent.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public KeyEvent.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KeyEvent.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public KeyEvent.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
KeyEvent.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final KeyEvent.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
KeyEvent.Builder
Overrides

setCountingMethod(KeyEvent.CountingMethod value)

public KeyEvent.Builder setCountingMethod(KeyEvent.CountingMethod value)

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

Parameter
Name Description
value KeyEvent.CountingMethod

The countingMethod to set.
Returns
Type Description
KeyEvent.Builder

This builder for chaining.

setCountingMethodValue(int value)

public KeyEvent.Builder setCountingMethodValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for countingMethod to set.
Returns
Type Description
KeyEvent.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public KeyEvent.Builder setCreateTime(Timestamp value)

Output only. Time when this key event was created in the property.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
KeyEvent.Builder

setCreateTime(Timestamp.Builder builderForValue)

public KeyEvent.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Time when this key event was created in the property.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
KeyEvent.Builder

setCustom(boolean value)

public KeyEvent.Builder setCustom(boolean value)

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

Parameter
Name Description
value boolean

The custom to set.
Returns
Type Description
KeyEvent.Builder

This builder for chaining.

setDefaultValue(KeyEvent.DefaultValue value)

public KeyEvent.Builder setDefaultValue(KeyEvent.DefaultValue value)

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

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

Parameter
Name Description
value KeyEvent.DefaultValue
Returns
Type Description
KeyEvent.Builder

setDefaultValue(KeyEvent.DefaultValue.Builder builderForValue)

public KeyEvent.Builder setDefaultValue(KeyEvent.DefaultValue.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue KeyEvent.DefaultValue.Builder
Returns
Type Description
KeyEvent.Builder

setDeletable(boolean value)

public KeyEvent.Builder setDeletable(boolean value)

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

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

Parameter
Name Description
value boolean

The deletable to set.
Returns
Type Description
KeyEvent.Builder

This builder for chaining.

setEventName(String value)

public KeyEvent.Builder setEventName(String value)

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

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

Parameter
Name Description
value String

The eventName to set.
Returns
Type Description
KeyEvent.Builder

This builder for chaining.

setEventNameBytes(ByteString value)

public KeyEvent.Builder setEventNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for eventName to set.
Returns
Type Description
KeyEvent.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public KeyEvent.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
KeyEvent.Builder
Overrides

setName(String value)

public KeyEvent.Builder setName(String value)

Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
KeyEvent.Builder

This builder for chaining.

setNameBytes(ByteString value)

public KeyEvent.Builder setNameBytes(ByteString value)

Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
KeyEvent.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public KeyEvent.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
KeyEvent.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final KeyEvent.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
KeyEvent.Builder
Overrides