Package com.buildless.telemetry
Class TelemetryEvent
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.buildless.telemetry.TelemetryEvent
- All Implemented Interfaces:
TelemetryEventOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
public final class TelemetryEvent
extends com.google.protobuf.GeneratedMessageV3
implements TelemetryEventOrBuilder
## Telemetry: Event Describes the structure of an event which is emitted by, or consumed by, Buildless. For example, build analytics and cache events are modeled using telemetry events.Protobuf type
buildless.telemetry.TelemetryEvent- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class## Telemetry: Event Describes the structure of an event which is emitted by, or consumed by, Buildless.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleangetContext(int index) Specifies contextual information references which relate to this event.intSpecifies contextual information references which relate to this event.Specifies contextual information references which relate to this event.getContextOrBuilder(int index) Specifies contextual information references which relate to this event.List<? extends EventContextOrBuilder>Specifies contextual information references which relate to this event.com.google.protobuf.AnygetData()Raw data attached to this event.com.google.protobuf.AnyOrBuilderRaw data attached to this event.static TelemetryEventstatic final com.google.protobuf.Descriptors.DescriptorDetailed information about this event.Detailed information about this event.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.ByteStringSpecifies 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.Specifies location information for this event payload.Specifies location information for this event payload.intSpecifies the ordinal index of this event, within the set of events delivered for this timer or session.com.google.protobuf.Parser<TelemetryEvent>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.ByteStringSpecifies 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.intSpecifies the organization tenant which this event is associated with.com.google.protobuf.ByteStringSpecifies the organization tenant which this event is associated with.com.google.protobuf.ByteStringgetTimer()Raw bytes of a timer ID which relates multiple events to each other.Timing information for this event.Timing information for this event.getUser()Specifies the user account which this event is associated with.com.google.protobuf.ByteStringSpecifies the user account which this event is associated with.booleanhasData()Raw data attached to this event.booleanDetailed information about this event.inthashCode()booleanSpecifies location information for this event payload.booleanTiming information for this event.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanstatic TelemetryEvent.Builderstatic TelemetryEvent.BuildernewBuilder(TelemetryEvent prototype) protected TelemetryEvent.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static TelemetryEventparseDelimitedFrom(InputStream input) static TelemetryEventparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TelemetryEventparseFrom(byte[] data) static TelemetryEventparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TelemetryEventparseFrom(com.google.protobuf.ByteString data) static TelemetryEventparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TelemetryEventparseFrom(com.google.protobuf.CodedInputStream input) static TelemetryEventparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TelemetryEventparseFrom(InputStream input) static TelemetryEventparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TelemetryEventparseFrom(ByteBuffer data) static TelemetryEventparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<TelemetryEvent>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
SCOPE_FIELD_NUMBER
public static final int SCOPE_FIELD_NUMBER- See Also:
-
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER- See Also:
-
TENANT_FIELD_NUMBER
public static final int TENANT_FIELD_NUMBER- See Also:
-
USER_FIELD_NUMBER
public static final int USER_FIELD_NUMBER- See Also:
-
CONTEXT_FIELD_NUMBER
public static final int CONTEXT_FIELD_NUMBER- See Also:
-
DETAIL_FIELD_NUMBER
public static final int DETAIL_FIELD_NUMBER- See Also:
-
TIMING_FIELD_NUMBER
public static final int TIMING_FIELD_NUMBER- See Also:
-
LOCATION_FIELD_NUMBER
public static final int LOCATION_FIELD_NUMBER- See Also:
-
TIMER_FIELD_NUMBER
public static final int TIMER_FIELD_NUMBER- See Also:
-
ORDINAL_FIELD_NUMBER
public static final int ORDINAL_FIELD_NUMBER- See Also:
-
DATA_FIELD_NUMBER
public static final int DATA_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
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) = { ... }- Specified by:
getScopein interfaceTelemetryEventOrBuilder- Returns:
- The scope.
-
getScopeBytes
public 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) = { ... }- Specified by:
getScopeBytesin interfaceTelemetryEventOrBuilder- Returns:
- The bytes for scope.
-
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) = { ... }- Specified by:
getIdin interfaceTelemetryEventOrBuilder- Returns:
- The id.
-
getIdBytes
public 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) = { ... }- Specified by:
getIdBytesin interfaceTelemetryEventOrBuilder- Returns:
- The bytes for id.
-
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) = { ... }- Specified by:
getTenantin interfaceTelemetryEventOrBuilder- Returns:
- The tenant.
-
getTenantBytes
public 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) = { ... }- Specified by:
getTenantBytesin interfaceTelemetryEventOrBuilder- Returns:
- The bytes for tenant.
-
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) = { ... }- Specified by:
getUserin interfaceTelemetryEventOrBuilder- Returns:
- The user.
-
getUserBytes
public 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) = { ... }- Specified by:
getUserBytesin interfaceTelemetryEventOrBuilder- Returns:
- The bytes for user.
-
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) = { ... }- Specified by:
getContextListin interfaceTelemetryEventOrBuilder
-
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) = { ... }- Specified by:
getContextOrBuilderListin interfaceTelemetryEventOrBuilder
-
getContextCount
public 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) = { ... }- Specified by:
getContextCountin interfaceTelemetryEventOrBuilder
-
getContext
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) = { ... }- Specified by:
getContextin interfaceTelemetryEventOrBuilder
-
getContextOrBuilder
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) = { ... }- Specified by:
getContextOrBuilderin interfaceTelemetryEventOrBuilder
-
hasDetail
public 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) = { ... }- Specified by:
hasDetailin interfaceTelemetryEventOrBuilder- Returns:
- Whether the detail field is set.
-
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) = { ... }- Specified by:
getDetailin interfaceTelemetryEventOrBuilder- Returns:
- The detail.
-
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) = { ... }- Specified by:
getDetailOrBuilderin interfaceTelemetryEventOrBuilder
-
hasTiming
public 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) = { ... }- Specified by:
hasTimingin interfaceTelemetryEventOrBuilder- Returns:
- Whether the timing field is set.
-
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) = { ... }- Specified by:
getTimingin interfaceTelemetryEventOrBuilder- Returns:
- The timing.
-
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) = { ... }- Specified by:
getTimingOrBuilderin interfaceTelemetryEventOrBuilder
-
hasLocation
public 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];- Specified by:
hasLocationin interfaceTelemetryEventOrBuilder- Returns:
- Whether the location field is set.
-
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];- Specified by:
getLocationin interfaceTelemetryEventOrBuilder- Returns:
- The location.
-
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];- Specified by:
getLocationOrBuilderin interfaceTelemetryEventOrBuilder
-
getTimer
public 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) = { ... }- Specified by:
getTimerin interfaceTelemetryEventOrBuilder- Returns:
- The timer.
-
getOrdinal
public 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];- Specified by:
getOrdinalin interfaceTelemetryEventOrBuilder- Returns:
- The ordinal.
-
hasData
public 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];- Specified by:
hasDatain interfaceTelemetryEventOrBuilder- Returns:
- Whether the data field is set.
-
getData
public 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];- Specified by:
getDatain interfaceTelemetryEventOrBuilder- Returns:
- The data.
-
getDataOrBuilder
public 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];- Specified by:
getDataOrBuilderin interfaceTelemetryEventOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static TelemetryEvent parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TelemetryEvent parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TelemetryEvent parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TelemetryEvent parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TelemetryEvent parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TelemetryEvent parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static TelemetryEvent parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static TelemetryEvent parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static TelemetryEvent parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static TelemetryEvent parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected TelemetryEvent.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-