Class: Google::Logging::V2::WriteLogEntriesRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/logging/v2/doc/google/logging/v2/logging.rb

Overview

The parameters to WriteLogEntries.

Instance Attribute Summary collapse

Instance Attribute Details

#entries ⇒ Array<Google::Logging::V2::LogEntry>

Returns Required. The log entries to write. Values supplied for the fields +log_name+, +resource+, and +labels+ in this +entries.write+ request are added to those log entries that do not provide their own values for the fields.

To improve throughput and to avoid exceeding the limit[https://cloud.google.com/logging/quota-policy] for calls to +entries.write+, you should write multiple log entries at once rather than calling this method for each individual log entry.

Returns:

  • (Array<Google::Logging::V2::LogEntry>) —

    Required. The log entries to write. Values supplied for the fields +log_name+, +resource+, and +labels+ in this +entries.write+ request are added to those log entries that do not provide their own values for the fields.

    To improve throughput and to avoid exceeding the limit[https://cloud.google.com/logging/quota-policy] for calls to +entries.write+, you should write multiple log entries at once rather than calling this method for each individual log entry.



81
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging.rb', line 81

class WriteLogEntriesRequest; end

#labels ⇒ Hash{String => String}

Returns Optional. Default labels that are added to the +labels+ field of all log entries in +entries+. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.

Returns:

  • (Hash{String => String}) —

    Optional. Default labels that are added to the +labels+ field of all log entries in +entries+. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.



81
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging.rb', line 81

class WriteLogEntriesRequest; end

#log_name ⇒ String

Returns Optional. A default log resource name that is assigned to all log entries in +entries+ that do not specify a value for +log_name+:

"projects/[PROJECT_ID]/logs/[LOG_ID]"
"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"

+[LOG_ID]+ must be URL-encoded. For example, +"projects/my-project-id/logs/syslog"+ or +"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"+. For more information about log names, see LogEntry.

Returns:

  • (String) —

    Optional. A default log resource name that is assigned to all log entries in +entries+ that do not specify a value for +log_name+:

    "projects/[PROJECT_ID]/logs/[LOG_ID]"
"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"

    +[LOG_ID]+ must be URL-encoded. For example, +"projects/my-project-id/logs/syslog"+ or +"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"+. For more information about log names, see LogEntry.



81
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging.rb', line 81

class WriteLogEntriesRequest; end

#partial_success ⇒ true, false

Returns Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, the response status will be the error associated with one of the failed entries and include error details in the form of WriteLogEntriesPartialErrors.

Returns:

  • (true, false) —

    Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, the response status will be the error associated with one of the failed entries and include error details in the form of WriteLogEntriesPartialErrors.



81
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging.rb', line 81

class WriteLogEntriesRequest; end

#resource ⇒ Google::Api::MonitoredResource

Returns Optional. A default monitored resource object that is assigned to all log entries in +entries+ that do not specify a value for +resource+. Example:

{ "type": "gce_instance",
  "labels": {
    "zone": "us-central1-a", "instance_id": "00000000000000000000" }}

See LogEntry.

Returns:

  • (Google::Api::MonitoredResource) —

    Optional. A default monitored resource object that is assigned to all log entries in +entries+ that do not specify a value for +resource+. Example:

    { "type": "gce_instance",
  "labels": {
    "zone": "us-central1-a", "instance_id": "00000000000000000000" }}

    See LogEntry.



81
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging.rb', line 81

class WriteLogEntriesRequest; end