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 Stackdriver 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, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::LogMetric
Creates a logs-based metric.
-
#create_project_sink(parent, log_sink_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::LogSink
Creates a sink.
-
#delete_billing_account_log(log_name, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::Empty
Deletes a log and all its log entries.
-
#delete_log(log_name, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::Empty
Deletes a log and all its log entries.
-
#delete_organization_log(log_name, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::Empty
Deletes a log and all its log entries.
-
#delete_project_metric(metric_name, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::Empty
Deletes a logs-based metric.
-
#delete_project_sink(sink_name, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::Empty
Deletes a sink.
-
#get_project_metric(metric_name, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::LogMetric
Gets a logs-based metric.
-
#get_project_sink(sink_name, quota_user: nil, fields: 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, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::ListLogEntriesResponse
Lists log entries.
-
#list_monitored_resource_descriptors(page_size: nil, page_token: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::ListMonitoredResourceDescriptorsResponse
Lists the monitored resource descriptors used by Stackdriver Logging.
-
#list_project_metrics(parent, page_size: nil, page_token: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::ListLogMetricsResponse
Lists logs-based metrics.
-
#list_project_sinks(parent, page_size: nil, page_token: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::ListSinksResponse
Lists sinks.
-
#update_project_metric(metric_name, log_metric_object = nil, quota_user: nil, fields: 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, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::LogSink
Updates or creates a sink.
-
#write_entry_log_entries(write_log_entries_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::WriteLogEntriesResponse
Writes log entries to Stackdriver Logging.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Constructor Details
#initialize ⇒ LoggingService
Returns a new instance of LoggingService.
45 46 47 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 45 def initialize super('https://logging.googleapis.com/', '') 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, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::LogMetric
Creates a logs-based metric.
140 141 142 143 144 145 146 147 148 149 150 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 140 def create_project_metric(parent, log_metric_object = nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#create_project_sink(parent, log_sink_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::LogSink
Creates a sink.
346 347 348 349 350 351 352 353 354 355 356 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 346 def create_project_sink(parent, log_sink_object = nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#delete_billing_account_log(log_name, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::Empty
Deletes a log and all its log entries. The log will reappear if it receives new entries.
588 589 590 591 592 593 594 595 596 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 588 def delete_billing_account_log(log_name, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta1/{+logName}', ) command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation command.response_class = Google::Apis::LoggingV2beta1::Empty command.params['logName'] = log_name unless log_name.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#delete_log(log_name, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::Empty
Deletes a log and all its log entries. The log will reappear if it receives new entries.
247 248 249 250 251 252 253 254 255 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 247 def delete_log(log_name, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta1/{+logName}', ) command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation command.response_class = Google::Apis::LoggingV2beta1::Empty command.params['logName'] = log_name unless log_name.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#delete_organization_log(log_name, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::Empty
Deletes a log and all its log entries. The log will reappear if it receives new entries.
455 456 457 458 459 460 461 462 463 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 455 def delete_organization_log(log_name, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta1/{+logName}', ) command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation command.response_class = Google::Apis::LoggingV2beta1::Empty command.params['logName'] = log_name unless log_name.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#delete_project_metric(metric_name, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::Empty
Deletes a logs-based metric.
215 216 217 218 219 220 221 222 223 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 215 def delete_project_metric(metric_name, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#delete_project_sink(sink_name, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::Empty
Deletes a sink.
423 424 425 426 427 428 429 430 431 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 423 def delete_project_sink(sink_name, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#get_project_metric(metric_name, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::LogMetric
Gets a logs-based metric.
107 108 109 110 111 112 113 114 115 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 107 def get_project_metric(metric_name, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#get_project_sink(sink_name, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::LogSink
Gets a sink.
313 314 315 316 317 318 319 320 321 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 313 def get_project_sink(sink_name, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#list_entry_log_entries(list_log_entries_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::ListLogEntriesResponse
Lists log entries. Use this method to retrieve log entries from Cloud Logging. For ways to export log entries, see Exporting Logs.
517 518 519 520 521 522 523 524 525 526 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 517 def list_entry_log_entries(list_log_entries_request_object = nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#list_monitored_resource_descriptors(page_size: nil, page_token: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::ListMonitoredResourceDescriptorsResponse
Lists the monitored resource descriptors used by Stackdriver Logging.
555 556 557 558 559 560 561 562 563 564 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 555 def list_monitored_resource_descriptors(page_size: nil, page_token: nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#list_project_metrics(parent, page_size: nil, page_token: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::ListLogMetricsResponse
Lists logs-based metrics.
182 183 184 185 186 187 188 189 190 191 192 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 182 def list_project_metrics(parent, page_size: nil, page_token: nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#list_project_sinks(parent, page_size: nil, page_token: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::ListSinksResponse
Lists sinks.
388 389 390 391 392 393 394 395 396 397 398 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 388 def list_project_sinks(parent, page_size: nil, page_token: nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#update_project_metric(metric_name, log_metric_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::LogMetric
Creates or updates a logs-based metric.
74 75 76 77 78 79 80 81 82 83 84 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 74 def update_project_metric(metric_name, log_metric_object = nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#update_project_sink(sink_name, log_sink_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::LogSink
Updates or creates a sink.
280 281 282 283 284 285 286 287 288 289 290 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 280 def update_project_sink(sink_name, log_sink_object = nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#write_entry_log_entries(write_log_entries_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LoggingV2beta1::WriteLogEntriesResponse
Writes log entries to Stackdriver Logging. All log entries are written by this method.
485 486 487 488 489 490 491 492 493 494 |
# File 'generated/google/apis/logging_v2beta1/service.rb', line 485 def write_entry_log_entries(write_log_entries_request_object = nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |