Package com.buildless.service.v1
Interface EventOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Event,Event.Builder
public interface EventOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionSpecifies the collection to which this event belongs.com.google.protobuf.ByteStringSpecifies the collection to which this event belongs.getEvent()Specifies the payload of the event being delivered.Specifies the payload of the event being delivered.booleangetFin()Whether this event is a standalone event (`true`), or part of a series (`false`).intgetIndex()Index of this event within the ordinal context of all events sent for a given event stream or session.getScope()Scope or operational context ID for this event.com.google.protobuf.ByteStringScope or operational context ID for this event.booleanhasEvent()Specifies the payload of the event being delivered.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getCollection
String getCollection()Specifies the collection to which this event belongs. Named event collections are used for certain types of events which are grouped together for reporting purposes.
string collection = 1 [json_name = "collection", (.google.api.field_behavior) = OPTIONAL, (.validate.rules) = { ... }- Returns:
- The collection.
-
getCollectionBytes
com.google.protobuf.ByteString getCollectionBytes()Specifies the collection to which this event belongs. Named event collections are used for certain types of events which are grouped together for reporting purposes.
string collection = 1 [json_name = "collection", (.google.api.field_behavior) = OPTIONAL, (.validate.rules) = { ... }- Returns:
- The bytes for collection.
-
getFin
boolean getFin()Whether this event is a standalone event (`true`), or part of a series (`false`). Only applicable when sending streams of events.
bool fin = 2 [json_name = "fin", (.google.api.field_behavior) = OPTIONAL];- Returns:
- The fin.
-
getIndex
int getIndex()Index of this event within the ordinal context of all events sent for a given event stream or session. Only applicable in circumstances where events have a natural order.
uint32 index = 3 [json_name = "index", (.google.api.field_behavior) = OPTIONAL];- Returns:
- The index.
-
getScope
String getScope()Scope or operational context ID for this event. This value may be mixed into the event's ID and other data. This value is optional. For example, it may be filled in with a build ID in CI systems.
string scope = 4 [json_name = "scope", (.google.api.field_behavior) = OPTIONAL];- Returns:
- The scope.
-
getScopeBytes
com.google.protobuf.ByteString getScopeBytes()Scope or operational context ID for this event. This value may be mixed into the event's ID and other data. This value is optional. For example, it may be filled in with a build ID in CI systems.
string scope = 4 [json_name = "scope", (.google.api.field_behavior) = OPTIONAL];- Returns:
- The bytes for scope.
-
hasEvent
boolean hasEvent()Specifies the payload of the event being delivered. This field is required and constitutes the actual content of the event which should be validated, enriched, and persisted.
.buildless.telemetry.TelemetryEvent event = 5 [json_name = "event", (.google.api.field_behavior) = REQUIRED, (.validate.rules) = { ... }- Returns:
- Whether the event field is set.
-
getEvent
TelemetryEvent getEvent()Specifies the payload of the event being delivered. This field is required and constitutes the actual content of the event which should be validated, enriched, and persisted.
.buildless.telemetry.TelemetryEvent event = 5 [json_name = "event", (.google.api.field_behavior) = REQUIRED, (.validate.rules) = { ... }- Returns:
- The event.
-
getEventOrBuilder
TelemetryEventOrBuilder getEventOrBuilder()Specifies the payload of the event being delivered. This field is required and constitutes the actual content of the event which should be validated, enriched, and persisted.
.buildless.telemetry.TelemetryEvent event = 5 [json_name = "event", (.google.api.field_behavior) = REQUIRED, (.validate.rules) = { ... }
-