Class KeyEvent.Builder (0.61.0)

Version 0.61.0

• 0.62.0 (latest)
• 0.61.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.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.v1beta.KeyEvent

Inheritance

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

Implements

KeyEventOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCountingMethod()

public KeyEvent.Builder clearCountingMethod()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public KeyEvent.Builder clone()

Returns
Type	Description
KeyEvent.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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.

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public KeyEvent.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
KeyEvent.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final KeyEvent.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
KeyEvent.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final KeyEvent.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
KeyEvent.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)