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

#dry_run ⇒ true, false

Returns Optional. If true, the request should expect normal response, but the entries won't be persisted nor exported. Useful for checking whether the logging API endpoints are working properly before sending valuable data.

Returns:

  • (true, false) —

    Optional. If true, the request should expect normal response, but the entries won't be persisted nor exported. Useful for checking whether the logging API endpoints are working properly before sending valuable data.



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

class WriteLogEntriesRequest; end

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

Returns Required. The log entries to send to Stackdriver Logging. The order of log entries in this list does not matter. Values supplied in this method's +log_name+, +resource+, and +labels+ fields are copied into those log entries in this list that do not include values for their corresponding fields. For more information, see the LogEntry type.

If the +timestamp+ or +insert_id+ fields are missing in log entries, then this method supplies the current time or a unique identifier, respectively. The supplied values are chosen so that, among the log entries that did not supply their own values, the entries earlier in the list will sort before the entries later in the list. See the +entries.list+ method.

Log entries with timestamps that are more than the logs retention period in the past or more than 24 hours in the future will not be available when calling +entries.list+. However, those log entries can still be exported with LogSinks.

To improve throughput and to avoid exceeding the quota limit for calls to +entries.write+, you should try to include several log entries in this list, rather than calling this method for each individual log entry.

Returns:

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

    Required. The log entries to send to Stackdriver Logging. The order of log entries in this list does not matter. Values supplied in this method's +log_name+, +resource+, and +labels+ fields are copied into those log entries in this list that do not include values for their corresponding fields. For more information, see the LogEntry type.

    If the +timestamp+ or +insert_id+ fields are missing in log entries, then this method supplies the current time or a unique identifier, respectively. The supplied values are chosen so that, among the log entries that did not supply their own values, the entries earlier in the list will sort before the entries later in the list. See the +entries.list+ method.

    Log entries with timestamps that are more than the logs retention period in the past or more than 24 hours in the future will not be available when calling +entries.list+. However, those log entries can still be exported with LogSinks.

    To improve throughput and to avoid exceeding the quota limit for calls to +entries.write+, you should try to include several log entries in this list, rather than calling this method for each individual log entry.



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

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.



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

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]"
"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
"folders/[FOLDER_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]"
"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
"folders/[FOLDER_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.



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

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, then the response status is the error associated with one of the failed entries and the response includes error details keyed by the entries' zero-based index in the +entries.write+ method.

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, then the response status is the error associated with one of the failed entries and the response includes error details keyed by the entries' zero-based index in the +entries.write+ method.



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

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.



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

class WriteLogEntriesRequest; end