LogEntry class

An individual entry in a log.

Inheritance
Available extensions

Constructors

LogEntry({Any? protoPayload, String? textPayload, String? insertId, Struct? jsonPayload, HttpRequest? httpRequest, MonitoredResource? resource, Timestamp? timestamp, LogSeverity? severity, Map<String, String>? labels, String? logName, LogEntryOperation? operation, String? trace, LogEntrySourceLocation? sourceLocation, Timestamp? receiveTimestamp, String? spanId, bool? traceSampled, LogSplit? split})
factory
LogEntry.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory
LogEntry.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory

Properties

hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
httpRequest ↔ HttpRequest
Optional. Information about the HTTP request associated with this log entry, if applicable.
getter/setter pair
info_ → BuilderInfo
no setteroverride
insertId ↔ String
Optional. A unique identifier for the log entry. If you provide a value, then Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which are removed in a single query result. However, there are no guarantees of de-duplication in the export of logs.
getter/setter pair
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
jsonPayload ↔ Struct
The log entry payload, represented as a structure that is expressed as a JSON object.
getter/setter pair
labels → Map<String, String>
Optional. A map of key, value pairs that provides additional information about the log entry. The labels can be user-defined or system-defined.
no setter
logName ↔ String
Required. The resource name of the log to which this log entry belongs:
getter/setter pair
operation ↔ LogEntryOperation
Optional. Information about an operation associated with the log entry, if applicable.
getter/setter pair
protoPayload ↔ Any
The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.
getter/setter pair
receiveTimestamp ↔ Timestamp
Output only. The time the log entry was received by Logging.
getter/setter pair
resource ↔ MonitoredResource
Required. The monitored resource that produced this log entry.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
severity ↔ LogSeverity
Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.
getter/setter pair
sourceLocation ↔ LogEntrySourceLocation
Optional. Source code location information associated with the log entry, if any.
getter/setter pair
spanId ↔ String
Optional. The ID of the Cloud Trace span associated with the current operation in which the log is being written. For example, if a span has the REST resource name of "projects/some-project/traces/some-trace/spans/some-span-id", then the span_id field is "some-span-id".
getter/setter pair
split ↔ LogSplit
Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry.
getter/setter pair
textPayload ↔ String
The log entry payload, represented as a Unicode string (UTF-8).
getter/setter pair
timestamp ↔ Timestamp
Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp is displayed.
getter/setter pair
trace ↔ String
Optional. The REST resource name of the trace being written to Cloud Trace in association with this log entry. For example, if your trace data is stored in the Cloud project "my-trace-project" and if the service that is creating the log entry receives a trace header that includes the trace ID "12345", then the service should use "projects/my-tracing-project/traces/12345".
getter/setter pair
traceSampled ↔ bool
Optional. The sampling decision of the trace associated with the log entry.
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
Throws a StateError if the message has required fields without a value.
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearHttpRequest() → void
clearInsertId() → void
clearJsonPayload() → void
clearLogName() → void
clearOperation() → void
clearPayload() → void
clearProtoPayload() → void
clearReceiveTimestamp() → void
clearResource() → void
clearSeverity() → void
clearSourceLocation() → void
clearSpanId() → void
clearSplit() → void
clearTextPayload() → void
clearTimestamp() → void
clearTrace() → void
clearTraceSampled() → void
clone() → LogEntry
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
override
copyWith(void updates(LogEntry)) → LogEntry
Apply updates to a copy of this message.
override
createEmptyInstance() → LogEntry
Creates an empty instance of the same message type as this.
override
deepCopy() → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Returns a writable deep copy of this message.
ensureHttpRequest() → HttpRequest
ensureJsonPayload() → Struct
ensureOperation() → LogEntryOperation
ensureProtoPayload() → Any
ensureReceiveTimestamp() → Timestamp
ensureResource() → MonitoredResource
ensureSourceLocation() → LogEntrySourceLocation
ensureSplit() → LogSplit
ensureTimestamp() → Timestamp
extensionsAreInitialized() → bool
inherited
freeze() → GeneratedMessage
Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?
inherited
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasHttpRequest() → bool
hasInsertId() → bool
hasJsonPayload() → bool
hasLogName() → bool
hasOperation() → bool
hasProtoPayload() → bool
hasReceiveTimestamp() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasResource() → bool
hasSeverity() → bool
hasSourceLocation() → bool
hasSpanId() → bool
hasSplit() → bool
hasTextPayload() → bool
hasTimestamp() → bool
hasTrace() → bool
hasTraceSampled() → bool
isInitialized() → bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Same as mergeFromBuffer, but takes a CodedBufferReader input.
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(void updates(T)) → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Apply updates to a copy of this message.
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() → String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String
Returns a String representation of this message.
inherited
whichPayload() → LogEntry_Payload
writeToBuffer() → Uint8List
Serialize the message as the protobuf binary format.
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
Same as writeToBuffer, but serializes to the given CodedBufferWriter.
inherited
writeToJson() → String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

create() → LogEntry
createRepeated() → PbList<LogEntry>
getDefault() → LogEntry