Package com.buildless.telemetry

Interface TelemetryEventOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
TelemetryEvent, TelemetryEvent.Builder
public interface TelemetryEventOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    EventContext
    getContext(int index)
    Specifies contextual information references which relate to this event.
    int
    getContextCount()
    Specifies contextual information references which relate to this event.
    List<EventContext>
    getContextList()
    Specifies contextual information references which relate to this event.
    EventContextOrBuilder
    getContextOrBuilder(int index)
    Specifies contextual information references which relate to this event.
    List<? extends EventContextOrBuilder>
    getContextOrBuilderList()
    Specifies contextual information references which relate to this event.
    com.google.protobuf.Any
    getData()
    Raw data attached to this event.
    com.google.protobuf.AnyOrBuilder
    getDataOrBuilder()
    Raw data attached to this event.
    EventDetail
    getDetail()
    Detailed information about this event.
    EventDetailOrBuilder
    getDetailOrBuilder()
    Detailed information about this event.
    String
    getId()
    Specifies a semi-unique ID for this event, which is used by the telemetry system to de-duplicate events at the time of delivery to the API.
    com.google.protobuf.ByteString
    getIdBytes()
    Specifies a semi-unique ID for this event, which is used by the telemetry system to de-duplicate events at the time of delivery to the API.
    EventLocation
    getLocation()
    Specifies location information for this event payload.
    EventLocationOrBuilder
    getLocationOrBuilder()
    Specifies location information for this event payload.
    int
    getOrdinal()
    Specifies the ordinal index of this event, within the set of events delivered for this timer or session.
    String
    getScope()
    Specifies a relevance scope for this event; this value is calculated by the system, and may be provided in some circumstances in order to group related events.
    com.google.protobuf.ByteString
    getScopeBytes()
    Specifies a relevance scope for this event; this value is calculated by the system, and may be provided in some circumstances in order to group related events.
    String
    getTenant()
    Specifies the organization tenant which this event is associated with.
    com.google.protobuf.ByteString
    getTenantBytes()
    Specifies the organization tenant which this event is associated with.
    com.google.protobuf.ByteString
    getTimer()
    Raw bytes of a timer ID which relates multiple events to each other.
    EventTiming
    getTiming()
    Timing information for this event.
    EventTimingOrBuilder
    getTimingOrBuilder()
    Timing information for this event.
    String
    getUser()
    Specifies the user account which this event is associated with.
    com.google.protobuf.ByteString
    getUserBytes()
    Specifies the user account which this event is associated with.
    boolean
    hasData()
    Raw data attached to this event.
    boolean
    hasDetail()
    Detailed information about this event.
    boolean
    hasLocation()
    Specifies location information for this event payload.
    boolean
    hasTiming()
    Timing information for this event.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getScope

      String getScope()
       Specifies a relevance scope for this event; this value is calculated by the system, and may be provided in some
 circumstances in order to group related events.
      string scope = 1 [json_name = "scope", (.google.api.field_behavior) = OUTPUT_ONLY, (.validate.rules) = { ... }
      Returns:
      The scope.

    • getScopeBytes

      com.google.protobuf.ByteString getScopeBytes()
       Specifies a relevance scope for this event; this value is calculated by the system, and may be provided in some
 circumstances in order to group related events.
      string scope = 1 [json_name = "scope", (.google.api.field_behavior) = OUTPUT_ONLY, (.validate.rules) = { ... }
      Returns:
      The bytes for scope.

    • getId

      String getId()
       Specifies a semi-unique ID for this event, which is used by the telemetry system to de-duplicate events at the time
 of delivery to the API. If an event has been received before, it may be rejected, or omitted during processing.
      string id = 2 [json_name = "id", (.google.api.field_behavior) = REQUIRED, (.validate.rules) = { ... }
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
       Specifies a semi-unique ID for this event, which is used by the telemetry system to de-duplicate events at the time
 of delivery to the API. If an event has been received before, it may be rejected, or omitted during processing.
      string id = 2 [json_name = "id", (.google.api.field_behavior) = REQUIRED, (.validate.rules) = { ... }
      Returns:
      The bytes for id.

    • getTenant

      String getTenant()
       Specifies the organization tenant which this event is associated with. This field is automatically added to the
 event based on the event source and API key, and is only present for organization-related events.
      string tenant = 3 [json_name = "tenant", (.google.api.field_behavior) = OPTIONAL, (.validate.rules) = { ... }
      Returns:
      The tenant.

    • getTenantBytes

      com.google.protobuf.ByteString getTenantBytes()
       Specifies the organization tenant which this event is associated with. This field is automatically added to the
 event based on the event source and API key, and is only present for organization-related events.
      string tenant = 3 [json_name = "tenant", (.google.api.field_behavior) = OPTIONAL, (.validate.rules) = { ... }
      Returns:
      The bytes for tenant.

    • getUser

      String getUser()
       Specifies the user account which this event is associated with. This field is automatically added to the event
 based on the event source and API key, and is only present for events which relate to a user.
      string user = 4 [json_name = "user", (.google.api.field_behavior) = OPTIONAL, (.validate.rules) = { ... }
      Returns:
      The user.

    • getUserBytes

      com.google.protobuf.ByteString getUserBytes()
       Specifies the user account which this event is associated with. This field is automatically added to the event
 based on the event source and API key, and is only present for events which relate to a user.
      string user = 4 [json_name = "user", (.google.api.field_behavior) = OPTIONAL, (.validate.rules) = { ... }
      Returns:
      The bytes for user.

    • getContextList

      List<EventContext> getContextList()
       Specifies contextual information references which relate to this event. Multiple event contexts can be specified
 for a single event.
      repeated .buildless.telemetry.EventContext context = 5 [json_name = "context", (.google.api.field_behavior) = REQUIRED, (.validate.rules) = { ... }

    • getContext

      EventContext getContext(int index)
       Specifies contextual information references which relate to this event. Multiple event contexts can be specified
 for a single event.
      repeated .buildless.telemetry.EventContext context = 5 [json_name = "context", (.google.api.field_behavior) = REQUIRED, (.validate.rules) = { ... }

    • getContextCount

      int getContextCount()
       Specifies contextual information references which relate to this event. Multiple event contexts can be specified
 for a single event.
      repeated .buildless.telemetry.EventContext context = 5 [json_name = "context", (.google.api.field_behavior) = REQUIRED, (.validate.rules) = { ... }

    • getContextOrBuilderList

      List<? extends EventContextOrBuilder> getContextOrBuilderList()
       Specifies contextual information references which relate to this event. Multiple event contexts can be specified
 for a single event.
      repeated .buildless.telemetry.EventContext context = 5 [json_name = "context", (.google.api.field_behavior) = REQUIRED, (.validate.rules) = { ... }

    • getContextOrBuilder

      EventContextOrBuilder getContextOrBuilder(int index)
       Specifies contextual information references which relate to this event. Multiple event contexts can be specified
 for a single event.
      repeated .buildless.telemetry.EventContext context = 5 [json_name = "context", (.google.api.field_behavior) = REQUIRED, (.validate.rules) = { ... }

    • hasDetail

      boolean hasDetail()
       Detailed information about this event. Most of this information is provided by the telemetry system automatically,
 and IDs referenced in this payload are expanded.
      .buildless.telemetry.EventDetail detail = 6 [json_name = "detail", (.google.api.field_behavior) = REQUIRED, (.validate.rules) = { ... }
      Returns:
      Whether the detail field is set.

    • getDetail

      EventDetail getDetail()
       Detailed information about this event. Most of this information is provided by the telemetry system automatically,
 and IDs referenced in this payload are expanded.
      .buildless.telemetry.EventDetail detail = 6 [json_name = "detail", (.google.api.field_behavior) = REQUIRED, (.validate.rules) = { ... }
      Returns:
      The detail.

    • getDetailOrBuilder

      EventDetailOrBuilder getDetailOrBuilder()
       Detailed information about this event. Most of this information is provided by the telemetry system automatically,
 and IDs referenced in this payload are expanded.
      .buildless.telemetry.EventDetail detail = 6 [json_name = "detail", (.google.api.field_behavior) = REQUIRED, (.validate.rules) = { ... }

    • hasTiming

      boolean hasTiming()
       Timing information for this event. This information is provided by the telemetry system automatically, except for
 the `occurred` timestamp, which is provided by the client.
      .buildless.telemetry.EventTiming timing = 7 [json_name = "timing", (.google.api.field_behavior) = REQUIRED, (.validate.rules) = { ... }
      Returns:
      Whether the timing field is set.

    • getTiming

      EventTiming getTiming()
       Timing information for this event. This information is provided by the telemetry system automatically, except for
 the `occurred` timestamp, which is provided by the client.
      .buildless.telemetry.EventTiming timing = 7 [json_name = "timing", (.google.api.field_behavior) = REQUIRED, (.validate.rules) = { ... }
      Returns:
      The timing.

    • getTimingOrBuilder

      EventTimingOrBuilder getTimingOrBuilder()
       Timing information for this event. This information is provided by the telemetry system automatically, except for
 the `occurred` timestamp, which is provided by the client.
      .buildless.telemetry.EventTiming timing = 7 [json_name = "timing", (.google.api.field_behavior) = REQUIRED, (.validate.rules) = { ... }

    • hasLocation

      boolean hasLocation()
       Specifies location information for this event payload. This information is either provided by the client, or, in
 some cases, a best-effort guess is made by the system on the server-side. All location information is optional.
      .buildless.telemetry.EventLocation location = 8 [json_name = "location", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the location field is set.

    • getLocation

      EventLocation getLocation()
       Specifies location information for this event payload. This information is either provided by the client, or, in
 some cases, a best-effort guess is made by the system on the server-side. All location information is optional.
      .buildless.telemetry.EventLocation location = 8 [json_name = "location", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The location.

    • getLocationOrBuilder

      EventLocationOrBuilder getLocationOrBuilder()
       Specifies location information for this event payload. This information is either provided by the client, or, in
 some cases, a best-effort guess is made by the system on the server-side. All location information is optional.
      .buildless.telemetry.EventLocation location = 8 [json_name = "location", (.google.api.field_behavior) = OPTIONAL];

    • getTimer

      com.google.protobuf.ByteString getTimer()
       Raw bytes of a timer ID which relates multiple events to each other. This value is expected and guaranteed to be
 unique within the scope of a given account and telemetry session.
      bytes timer = 9 [json_name = "timer", (.google.api.field_behavior) = OPTIONAL, (.validate.rules) = { ... }
      Returns:
      The timer.

    • getOrdinal

      int getOrdinal()
       Specifies the ordinal index of this event, within the set of events delivered for this timer or session. This acts
 as an ordering hint to the server, and is set by the client.
      uint32 ordinal = 10 [json_name = "ordinal", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The ordinal.

    • hasData

      boolean hasData()
       Raw data attached to this event. Custom data is opaque to the Buildless service. This field is optional, and may
 only be supported for some plans and accounts. Fields cannot start with the prefix `_buildless_`, or contain the
 string `buildless` at any position.
      .google.protobuf.Any data = 11 [json_name = "data", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the data field is set.

    • getData

      com.google.protobuf.Any getData()
       Raw data attached to this event. Custom data is opaque to the Buildless service. This field is optional, and may
 only be supported for some plans and accounts. Fields cannot start with the prefix `_buildless_`, or contain the
 string `buildless` at any position.
      .google.protobuf.Any data = 11 [json_name = "data", (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The data.

    • getDataOrBuilder

      com.google.protobuf.AnyOrBuilder getDataOrBuilder()
       Raw data attached to this event. Custom data is opaque to the Buildless service. This field is optional, and may
 only be supported for some plans and accounts. Fields cannot start with the prefix `_buildless_`, or contain the
 string `buildless` at any position.
      .google.protobuf.Any data = 11 [json_name = "data", (.google.api.field_behavior) = OPTIONAL];