Class: Google::Apis::LoggingV2beta1::WriteLogEntriesRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/logging_v2beta1/classes.rb,
generated/google/apis/logging_v2beta1/representations.rb,
generated/google/apis/logging_v2beta1/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.



90
91
92
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 90

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

Instance Attribute Details

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

Required. The log entries to write. The log entries must have values for all required fields. Corresponds to the JSON property entries

Returns:



78
79
80
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 78

def entries
  @entries
end

#labels ⇒ Hash<String,String>

Optional. User-defined key:value items that are added to the labels field of each log entry in entries, except when a log entry specifies its own key: value item with the same key. Example: "size": "large", "color":"red" Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


72
73
74
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 72

def labels
  @labels
end

#log_name ⇒ String

Optional. A default log resource name for those log entries in entries that do not specify their own logName. Example: "projects/my-project/logs/syslog" . See LogEntry. Corresponds to the JSON property logName

Returns:

  • (String) 


51
52
53
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 51

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, the response status will be the error associated with one of the failed entries and include error details in the form of WriteLogEntriesPartialErrors. Corresponds to the JSON property partialSuccess

Returns:

  • (Boolean) 


87
88
89
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 87

def partial_success
  @partial_success
end

#resource ⇒ Google::Apis::LoggingV2beta1::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": "my- instance", "zone": "us-central1-a" ` Corresponds to the JSON propertyresource`

Returns:



65
66
67
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 65

def resource
  @resource
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



95
96
97
98
99
100
101
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 95

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