Class: Google::Apis::LoggingV2::WriteLogEntriesRequest

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

The parameters to WriteLogEntries.

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) ⇒ WriteLogEntriesRequest

Returns a new instance of WriteLogEntriesRequest



1147
1148
1149
 
# File 'generated/google/apis/logging_v2/classes.rb', line 1147

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

Instance Attribute Details

#entries ⇒ Array<Google::Apis::LoggingV2::LogEntry>

Required. The log entries to write. Values supplied for the fields log_name, resource, and labels in this entries.write request are inserted into those log entries in this list that do not provide their own values.Stackdriver Logging also creates and inserts values for timestamp and insert_id if the entries do not provide them. The created insert_id for the N'th entry in this list will be greater than earlier entries and less than later entries. Otherwise, the order of log entries in this list does not matter.To improve throughput and to avoid exceeding the quota limit for calls to entries.write, you should write multiple log entries at once rather than calling this method for each individual log entry. Corresponds to the JSON property entries

Returns:



1112
1113
1114
 
# File 'generated/google/apis/logging_v2/classes.rb', line 1112

def entries
  @entries
end

#labels ⇒ 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. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1129
1130
1131
 
# File 'generated/google/apis/logging_v2/classes.rb', line 1129

def labels
  @labels
end

#log_name ⇒ 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. Corresponds to the JSON property logName

Returns:

  • (String) 


1098
1099
1100
 
# File 'generated/google/apis/logging_v2/classes.rb', line 1098

def log_name
  @log_name
end

#partial_success ⇒ Boolean Also known as: partial_success?

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. Corresponds to the JSON property partialSuccess

Returns:

  • (Boolean) 


1121
1122
1123
 
# File 'generated/google/apis/logging_v2/classes.rb', line 1121

def partial_success
  @partial_success
end

#resource ⇒ Google::Apis::LoggingV2::MonitoredResource

An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and " zone": "type": "gce_instance", "labels": "instance_id": "12345678901234", "zone": "us-central1-a" ` Corresponds to the JSON propertyresource`

Returns:



1145
1146
1147
 
# File 'generated/google/apis/logging_v2/classes.rb', line 1145

def resource
  @resource
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1152
1153
1154
1155
1156
1157
1158
 
# File 'generated/google/apis/logging_v2/classes.rb', line 1152

def update!(**args)
  @log_name = args[:log_name] if args.key?(:log_name)
  @entries = args[:entries] if args.key?(:entries)
  @partial_success = args[:partial_success] if args.key?(:partial_success)
  @labels = args[:labels] if args.key?(:labels)
  @resource = args[:resource] if args.key?(:resource)
end