Class: Google::Apis::LoggingV2::LogSink
- Inherits:
-
Object
- Object
- Google::Apis::LoggingV2::LogSink
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/logging_v2/classes.rb,
generated/google/apis/logging_v2/representations.rb,
generated/google/apis/logging_v2/representations.rb
Overview
Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
Instance Attribute Summary collapse
-
#destination ⇒ String
Required.
-
#end_time ⇒ String
Deprecated.
-
#filter ⇒ String
Optional.
-
#include_children ⇒ Boolean
(also: #include_children?)
Optional.
-
#name ⇒ String
Required.
-
#output_version_format ⇒ String
Deprecated.
-
#start_time ⇒ String
Deprecated.
-
#writer_identity ⇒ String
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ LogSink
constructor
A new instance of LogSink.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ LogSink
Returns a new instance of LogSink
1117 1118 1119 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1117 def initialize(**args) update!(**args) end |
Instance Attribute Details
#destination ⇒ String
Required. 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]"
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. For more
information, see Exporting Logs With Sinks.
Corresponds to the JSON property destination
1054 1055 1056 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1054 def destination @destination end |
#end_time ⇒ String
Deprecated. This field is ignored when creating or updating sinks.
Corresponds to the JSON property endTime
1059 1060 1061 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1059 def end_time @end_time end |
#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. For
example:
logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
Corresponds to the JSON property filter
1067 1068 1069 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1067 def filter @filter end |
#include_children ⇒ Boolean Also known as: include_children?
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 logs 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. For example,
if this field is true, then the filter resource.type=gce_instance would export
all Compute Engine VM instance log entries from all projects in the sink's
parent. To only export entries from certain child projects, filter on the
project part of the log name:
logName:("projects/test-project1/" OR "projects/test-project2/") AND
resource.type=gce_instance
Corresponds to the JSON property includeChildren
1083 1084 1085 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1083 def include_children @include_children end |
#name ⇒ String
Required. The client-assigned sink identifier, unique within the project.
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, and periods.
Corresponds to the JSON property name
1092 1093 1094 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1092 def name @name end |
#output_version_format ⇒ String
Deprecated. The log entry format to use for this sink's exported log entries.
The v2 format is used by default and cannot be changed.
Corresponds to the JSON property outputVersionFormat
1098 1099 1100 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1098 def output_version_format @output_version_format end |
#start_time ⇒ String
Deprecated. This field is ignored when creating or updating sinks.
Corresponds to the JSON property startTime
1103 1104 1105 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1103 def start_time @start_time end |
#writer_identity ⇒ String
Output only. An IAM identity—a service account or group—under
which Stackdriver Logging writes the exported log entries to the sink's
destination. This field is set by sinks.create and sinks.update, based on the
setting of unique_writer_identity in those methods.Until you grant this
identity write-access to the destination, log entry exports from this sink
will fail. For more information, see Granting access for a resource. Consult
the destination service's documentation to determine the appropriate IAM roles
to assign to the identity.
Corresponds to the JSON property writerIdentity
1115 1116 1117 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1115 def writer_identity @writer_identity end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1122 def update!(**args) @destination = args[:destination] if args.key?(:destination) @end_time = args[:end_time] if args.key?(:end_time) @filter = args[:filter] if args.key?(:filter) @include_children = args[:include_children] if args.key?(:include_children) @name = args[:name] if args.key?(:name) @output_version_format = args[:output_version_format] if args.key?(:output_version_format) @start_time = args[:start_time] if args.key?(:start_time) @writer_identity = args[:writer_identity] if args.key?(:writer_identity) end |