LogSink class

Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, a Pub/Sub topic or a Cloud Logging log bucket. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.

Available extensions

GeneratedMessageGenericExtensions

Constructors

LogSink({String? name, String? destination, String? filter, @Deprecated('This field is deprecated.') LogSink_VersionFormat? outputVersionFormat, String? writerIdentity, bool? includeChildren, BigQueryOptions? bigqueryOptions, Timestamp? createTime, Timestamp? updateTime, Iterable<LogExclusion>? exclusions, String? description, bool? disabled}): factory
LogSink.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]): factory
LogSink.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]): factory

Properties

bigqueryOptions ↔ BigQueryOptions: Optional. Options that affect sinks exporting data to BigQuery.
getter/setter pair
createTime ↔ Timestamp: Output only. The creation timestamp of the sink.
getter/setter pair
description ↔ String: Optional. A description of this sink.
getter/setter pair
destination ↔ String: Required. The export destination:
getter/setter pair
disabled ↔ bool: Optional. If set to true, then this sink is disabled and it does not export any log entries.
getter/setter pair
exclusions → PbList<LogExclusion>: Optional. Log entries that match any of these exclusion filters will not be exported.
no setter
filter ↔ String: Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter.
getter/setter pair
hashCode → int: Calculates a hash code based on the contents of the protobuf.
no setterinherited
includeChildren ↔ bool: Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then log entries from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression.
getter/setter pair
info_ → BuilderInfo: no setter
isFrozen → bool: Returns true if this message is marked read-only. Otherwise false.
no setterinherited
name ↔ String: Required. The client-assigned sink identifier, unique within the project.
getter/setter pair
outputVersionFormat ↔ LogSink_VersionFormat: Deprecated. This field is unused.
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
unknownFields → UnknownFieldSet: no setterinherited
updateTime ↔ Timestamp: Output only. The last update timestamp of the sink.
getter/setter pair
writerIdentity ↔ String: Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by google.logging.v2.ConfigServiceV2.CreateSink and google.logging.v2.ConfigServiceV2.UpdateSink based on the value of unique_writer_identity in those methods.
getter/setter pair

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
clearBigqueryOptions() → void
clearCreateTime() → void
clearDescription() → void
clearDestination() → void
clearDisabled() → void
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
clearFilter() → void
clearIncludeChildren() → void
clearName() → void
clearOptions() → void
clearOutputVersionFormat() → void
clearUpdateTime() → void
clearWriterIdentity() → void
clone() → LogSink: Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
copyWith(void updates(LogSink)) → LogSink: Apply updates to a copy of this message.
createEmptyInstance() → LogSink: Creates an empty instance of the same message type as this.
deepCopy() → T: Available on T, provided by the GeneratedMessageGenericExtensions extension
Returns a writable deep copy of this message.
ensureBigqueryOptions() → BigQueryOptions
ensureCreateTime() → Timestamp
ensureUpdateTime() → 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
hasBigqueryOptions() → bool
hasCreateTime() → bool
hasDescription() → bool
hasDestination() → bool
hasDisabled() → bool
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
hasFilter() → bool
hasIncludeChildren() → bool
hasName() → bool
hasOutputVersionFormat() → bool
hasRequiredFields() → bool: Whether the message has required fields.
inherited
hasUpdateTime() → bool
hasWriterIdentity() → 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
whichOptions() → LogSink_Options
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() → LogSink
createRepeated() → PbList<LogSink>
getDefault() → LogSink