LogSink class
Describes a sink used to export log entries to one of the following destinations: a Cloud Logging log bucket, a Cloud Storage bucket, a BigQuery dataset, a Pub/Sub topic, a Cloud project.A logs filter controls which log entries are exported.
The sink must be created within a project, organization, billing account, or folder.
Constructors
-
LogSink({BigQueryOptions? bigqueryOptions, String? createTime, String? description, String? destination, bool? disabled, List<
LogExclusion> ? exclusions, String? filter, bool? includeChildren, bool? interceptChildren, String? name, String? outputVersionFormat, String? resourceName, String? updateTime, String? writerIdentity}) - LogSink.fromJson(Map json_)
Properties
- bigqueryOptions ↔ BigQueryOptions?
-
Options that affect sinks exporting data to BigQuery.
getter/setter pair
- createTime ↔ String?
-
The creation timestamp of the sink.This field may not be present for older
sinks.
getter/setter pair
- description ↔ String?
-
A description of this sink.The maximum length of the description is 8000
characters.
getter/setter pair
- destination ↔ String?
-
The export destination: "storage.googleapis.com/[GCS_BUCKET]"
"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
"logging.googleapis.com/projects/[PROJECT_ID]"
"logging.googleapis.com/projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
The sink's writer_identity, set when the sink is created, must have
permission to write to the destination or else the log entries are not
exported.
getter/setter pair
- disabled ↔ bool?
-
If set to true, then this sink is disabled and it does not export any log
entries.
getter/setter pair
-
exclusions
↔ List<
LogExclusion> ? -
Log entries that match any of these exclusion filters will not be
exported.If a log entry is matched by both filter and one of
exclusion_filters it will not be exported.
getter/setter pair
- filter ↔ String?
-
An advanced logs filter
(https://cloud.google.com/logging/docs/view/advanced-queries).
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- includeChildren ↔ bool?
-
This field applies only to sinks owned by organizations and folders.
getter/setter pair
- interceptChildren ↔ bool?
-
This field applies only to sinks owned by organizations and folders.When
the value of 'intercept_children' is true, the following restrictions
apply: The sink must have the include_children flag set to true.
getter/setter pair
- name ↔ String?
-
The client-assigned sink identifier, unique within the project.For
example: "my-syslog-errors-to-pubsub".Sink identifiers are limited to 100
characters and can include only the following characters: upper and
lower-case alphanumeric characters, underscores, hyphens, periods.First
character has to be alphanumeric.
getter/setter pair
- outputVersionFormat ↔ String?
-
This field is unused.
getter/setter pair
- resourceName ↔ String?
-
The resource name of the sink.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- updateTime ↔ String?
-
The last update timestamp of the sink.This field may not be present for
older sinks.
getter/setter pair
- writerIdentity ↔ String?
-
An IAM identity—a service account or group—under which Cloud Logging
writes the exported log entries to the sink's destination.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited