Class: Google::Apis::LoggingV2beta1::LoggingService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::LoggingV2beta1::LoggingService
- Defined in:
- generated/google/apis/logging_v2beta1/service.rb
Overview
Stackdriver Logging API
Writes log entries and manages your Logging configuration.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#create_project_metric(parent, log_metric_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::LogMetric
Creates a logs-based metric.
-
#create_project_sink(parent, log_sink_object = nil, unique_writer_identity: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::LogSink
Creates a sink that exports specified log entries to a destination.
-
#delete_project_metric(metric_name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::Empty
Deletes a logs-based metric.
-
#delete_project_sink(sink_name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::Empty
Deletes a sink.
-
#get_project_metric(metric_name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::LogMetric
Gets a logs-based metric.
-
#get_project_sink(sink_name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::LogSink
Gets a sink.
-
#initialize ⇒ LoggingService
constructor
A new instance of LoggingService.
-
#list_entry_log_entries(list_log_entries_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::ListLogEntriesResponse
Lists log entries.
-
#list_monitored_resource_descriptors(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::ListMonitoredResourceDescriptorsResponse
Lists the descriptors for monitored resource types used by Logging.
-
#list_project_metrics(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::ListLogMetricsResponse
Lists logs-based metrics.
-
#list_project_sinks(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::ListSinksResponse
Lists sinks.
-
#update_project_metric(metric_name, log_metric_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::LogMetric
Creates or updates a logs-based metric.
-
#update_project_sink(sink_name, log_sink_object = nil, unique_writer_identity: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::LogSink
Updates a sink.
-
#write_entry_log_entries(write_log_entries_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::WriteLogEntriesResponse
Writes log entries to Logging.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ LoggingService
Returns a new instance of LoggingService
45 46 47 48 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 45 def initialize super('https://logging.googleapis.com/', '') @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
38 39 40 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 38 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
43 44 45 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 43 def quota_user @quota_user end |
Instance Method Details
#create_project_metric(parent, log_metric_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::LogMetric
Creates a logs-based metric.
177 178 179 180 181 182 183 184 185 186 187 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 177 def create_project_metric(parent, log_metric_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/{+parent}/metrics', ) command.request_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation command.request_object = log_metric_object command.response_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation command.response_class = Google::Apis::LoggingV2beta1::LogMetric command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_project_sink(parent, log_sink_object = nil, unique_writer_identity: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::LogSink
Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.
369 370 371 372 373 374 375 376 377 378 379 380 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 369 def create_project_sink(parent, log_sink_object = nil, unique_writer_identity: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/{+parent}/sinks', ) command.request_representation = Google::Apis::LoggingV2beta1::LogSink::Representation command.request_object = log_sink_object command.response_representation = Google::Apis::LoggingV2beta1::LogSink::Representation command.response_class = Google::Apis::LoggingV2beta1::LogSink command.params['parent'] = parent unless parent.nil? command.query['uniqueWriterIdentity'] = unique_writer_identity unless unique_writer_identity.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_metric(metric_name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::Empty
Deletes a logs-based metric.
210 211 212 213 214 215 216 217 218 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 210 def delete_project_metric(metric_name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta1/{+metricName}', ) command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation command.response_class = Google::Apis::LoggingV2beta1::Empty command.params['metricName'] = metric_name unless metric_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_sink(sink_name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::Empty
Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.
409 410 411 412 413 414 415 416 417 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 409 def delete_project_sink(sink_name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta1/{+sinkName}', ) command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation command.response_class = Google::Apis::LoggingV2beta1::Empty command.params['sinkName'] = sink_name unless sink_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_metric(metric_name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::LogMetric
Gets a logs-based metric.
241 242 243 244 245 246 247 248 249 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 241 def get_project_metric(metric_name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+metricName}', ) command.response_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation command.response_class = Google::Apis::LoggingV2beta1::LogMetric command.params['metricName'] = metric_name unless metric_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_sink(sink_name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::LogSink
Gets a sink.
444 445 446 447 448 449 450 451 452 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 444 def get_project_sink(sink_name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+sinkName}', ) command.response_representation = Google::Apis::LoggingV2beta1::LogSink::Representation command.response_class = Google::Apis::LoggingV2beta1::LogSink command.params['sinkName'] = sink_name unless sink_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_entry_log_entries(list_log_entries_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::ListLogEntriesResponse
Lists log entries. Use this method to retrieve log entries that originated from a project/folder/organization/billing account. For ways to export log entries, see Exporting Logs.
71 72 73 74 75 76 77 78 79 80 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 71 def list_entry_log_entries(list_log_entries_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/entries:list', ) command.request_representation = Google::Apis::LoggingV2beta1::ListLogEntriesRequest::Representation command.request_object = list_log_entries_request_object command.response_representation = Google::Apis::LoggingV2beta1::ListLogEntriesResponse::Representation command.response_class = Google::Apis::LoggingV2beta1::ListLogEntriesResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_monitored_resource_descriptors(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::ListMonitoredResourceDescriptorsResponse
Lists the descriptors for monitored resource types used by Logging.
143 144 145 146 147 148 149 150 151 152 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 143 def list_monitored_resource_descriptors(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/monitoredResourceDescriptors', ) command.response_representation = Google::Apis::LoggingV2beta1::ListMonitoredResourceDescriptorsResponse::Representation command.response_class = Google::Apis::LoggingV2beta1::ListMonitoredResourceDescriptorsResponse command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_metrics(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::ListLogMetricsResponse
Lists logs-based metrics.
281 282 283 284 285 286 287 288 289 290 291 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 281 def list_project_metrics(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+parent}/metrics', ) command.response_representation = Google::Apis::LoggingV2beta1::ListLogMetricsResponse::Representation command.response_class = Google::Apis::LoggingV2beta1::ListLogMetricsResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_sinks(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::ListSinksResponse
Lists sinks.
487 488 489 490 491 492 493 494 495 496 497 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 487 def list_project_sinks(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+parent}/sinks', ) command.response_representation = Google::Apis::LoggingV2beta1::ListSinksResponse::Representation command.response_class = Google::Apis::LoggingV2beta1::ListSinksResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#update_project_metric(metric_name, log_metric_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::LogMetric
Creates or updates a logs-based metric.
318 319 320 321 322 323 324 325 326 327 328 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 318 def update_project_metric(metric_name, log_metric_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v2beta1/{+metricName}', ) command.request_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation command.request_object = log_metric_object command.response_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation command.response_class = Google::Apis::LoggingV2beta1::LogMetric command.params['metricName'] = metric_name unless metric_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#update_project_sink(sink_name, log_sink_object = nil, unique_writer_identity: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::LogSink
Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field.
547 548 549 550 551 552 553 554 555 556 557 558 559 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 547 def update_project_sink(sink_name, log_sink_object = nil, unique_writer_identity: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v2beta1/{+sinkName}', ) command.request_representation = Google::Apis::LoggingV2beta1::LogSink::Representation command.request_object = log_sink_object command.response_representation = Google::Apis::LoggingV2beta1::LogSink::Representation command.response_class = Google::Apis::LoggingV2beta1::LogSink command.params['sinkName'] = sink_name unless sink_name.nil? command.query['uniqueWriterIdentity'] = unique_writer_identity unless unique_writer_identity.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#write_entry_log_entries(write_log_entries_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::WriteLogEntriesResponse
Writes log entries to Logging. This API method is the only way to send log entries to Logging. This method is used, directly or indirectly, by the Logging agent (fluentd) and all logging libraries configured to use Logging. A single request may contain log entries for a maximum of 1000 different resources (projects, organizations, billing accounts or folders)
105 106 107 108 109 110 111 112 113 114 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 105 def write_entry_log_entries(write_log_entries_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/entries:write', ) command.request_representation = Google::Apis::LoggingV2beta1::WriteLogEntriesRequest::Representation command.request_object = write_log_entries_request_object command.response_representation = Google::Apis::LoggingV2beta1::WriteLogEntriesResponse::Representation command.response_class = Google::Apis::LoggingV2beta1::WriteLogEntriesResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |