Class: Google::Apis::LoggingV2::LogSink

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ LogSink

Returns a new instance of LogSink.



1280
1281
1282
 
# File 'generated/google/apis/logging_v2/classes.rb', line 1280

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#bigquery_options ⇒ Google::Apis::LoggingV2::BigQueryOptions

Options that change functionality of a sink exporting data to BigQuery. Corresponds to the JSON property bigqueryOptions

Returns:



1180
1181
1182
 
# File 'generated/google/apis/logging_v2/classes.rb', line 1180

def bigquery_options
  @bigquery_options
end

#create_time ⇒ String

Output only. The creation timestamp of the sink.This field may not be present for older sinks. Corresponds to the JSON property createTime

Returns:

  • (String) 


1186
1187
1188
 
# File 'generated/google/apis/logging_v2/classes.rb', line 1186

def create_time
  @create_time
end

#description ⇒ String

Optional. A description of this sink. The maximum length of the description is 8000 characters. Corresponds to the JSON property description

Returns:

  • (String) 


1192
1193
1194
 
# File 'generated/google/apis/logging_v2/classes.rb', line 1192

def description
  @description
end

#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

Returns:

  • (String) 


1203
1204
1205
 
# File 'generated/google/apis/logging_v2/classes.rb', line 1203

def destination
  @destination
end

#disabled ⇒ Boolean Also known as: disabled?

Optional. If set to True, then this sink is disabled and it does not export any log entries. Corresponds to the JSON property disabled

Returns:

  • (Boolean) 


1209
1210
1211
 
# File 'generated/google/apis/logging_v2/classes.rb', line 1209

def disabled
  @disabled
end

#end_time ⇒ String

Do not use. This field is ignored. Corresponds to the JSON property endTime

Returns:

  • (String) 


1215
1216
1217
 
# File 'generated/google/apis/logging_v2/classes.rb', line 1215

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

Returns:

  • (String) 


1223
1224
1225
 
# File 'generated/google/apis/logging_v2/classes.rb', line 1223

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

Returns:

  • (Boolean) 


1239
1240
1241
 
# File 'generated/google/apis/logging_v2/classes.rb', line 1239

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. First character has to be alphanumeric. Corresponds to the JSON property name

Returns:

  • (String) 


1249
1250
1251
 
# File 'generated/google/apis/logging_v2/classes.rb', line 1249

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

Returns:

  • (String) 


1255
1256
1257
 
# File 'generated/google/apis/logging_v2/classes.rb', line 1255

def output_version_format
  @output_version_format
end

#start_time ⇒ String

Do not use. This field is ignored. Corresponds to the JSON property startTime

Returns:

  • (String) 


1260
1261
1262
 
# File 'generated/google/apis/logging_v2/classes.rb', line 1260

def start_time
  @start_time
end

#update_time ⇒ String

Output only. The last update timestamp of the sink.This field may not be present for older sinks. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1266
1267
1268
 
# File 'generated/google/apis/logging_v2/classes.rb', line 1266

def update_time
  @update_time
end

#writer_identity ⇒ String

Output only. An IAM identity—a service account or group—under which Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value 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

Returns:

  • (String) 


1278
1279
1280
 
# File 'generated/google/apis/logging_v2/classes.rb', line 1278

def writer_identity
  @writer_identity
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
 
# File 'generated/google/apis/logging_v2/classes.rb', line 1285

def update!(**args)
  @bigquery_options = args[:bigquery_options] if args.key?(:bigquery_options)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @destination = args[:destination] if args.key?(:destination)
  @disabled = args[:disabled] if args.key?(:disabled)
  @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)
  @update_time = args[:update_time] if args.key?(:update_time)
  @writer_identity = args[:writer_identity] if args.key?(:writer_identity)
end