Package com.google.analytics.admin.v1alpha

Class KeyEvent.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<KeyEvent.Builder>
com.google.analytics.admin.v1alpha.KeyEvent.Builder
All Implemented Interfaces:
KeyEventOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
KeyEvent
public static final class KeyEvent.Builder extends com.google.protobuf.GeneratedMessage.Builder<KeyEvent.Builder> implements KeyEventOrBuilder
 A key event in a Google Analytics property.
Protobuf type google.analytics.admin.v1alpha.KeyEvent

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

    • clear

      public KeyEvent.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<KeyEvent.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<KeyEvent.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public KeyEvent.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<KeyEvent.Builder>

    • mergeFrom

      public KeyEvent.Builder mergeFrom(KeyEvent other)

    • isInitialized

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

    • mergeFrom

      public KeyEvent.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<KeyEvent.Builder>
      Throws:
      IOException

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

    • setName

      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];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

    • setNameBytes

      public KeyEvent.Builder setNameBytes(com.google.protobuf.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];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

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

    • setEventName

      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];
      Parameters:
      value - The eventName to set.
      Returns:
      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:
      This builder for chaining.

    • setEventNameBytes

      public KeyEvent.Builder setEventNameBytes(com.google.protobuf.ByteString value)
       Immutable. The event name for this key event.
 Examples: 'click', 'purchase'
      string event_name = 2 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The bytes for eventName to set.
      Returns:
      This builder for chaining.

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

    • setCreateTime

      public KeyEvent.Builder setCreateTime(com.google.protobuf.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];

    • setCreateTime

      public KeyEvent.Builder setCreateTime(com.google.protobuf.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];

    • mergeCreateTime

      public KeyEvent.Builder mergeCreateTime(com.google.protobuf.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];

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

    • getCreateTimeBuilder

      public com.google.protobuf.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];

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

    • setDeletable

      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];
      Parameters:
      value - The deletable to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

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

    • setCustom

      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];
      Parameters:
      value - The custom to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

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

    • setCountingMethodValue

      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];
      Parameters:
      value - The enum numeric value on the wire for countingMethod to set.
      Returns:
      This builder for chaining.

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

    • setCountingMethod

      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];
      Parameters:
      value - The countingMethod to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

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

    • setDefaultValue

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

    • setDefaultValue

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

    • mergeDefaultValue

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

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

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

    • 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