Class: Google::Apis::LoggingV2beta1::LogEntry

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

An individual entry in a log.

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

Returns a new instance of LogEntry.



340
341
342
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 340

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

Instance Attribute Details

#http_request ⇒ Google::Apis::LoggingV2beta1::HttpRequest

A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message. Corresponds to the JSON property httpRequest

Returns:



262
263
264
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 262

def http_request
  @http_request
end

#insert_id ⇒ String

Optional. A unique ID for the log entry. If you provide this field, the logging service considers other log entries in the same project with the same ID as duplicates which can be removed. If omitted, Stackdriver Logging will generate a unique ID for this log entry. Corresponds to the JSON property insertId

Returns:

  • (String) 


332
333
334
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 332

def insert_id
  @insert_id
end

#json_payload ⇒ Hash<String,Object>

The log entry payload, represented as a structure that is expressed as a JSON object. Corresponds to the JSON property jsonPayload

Returns:

  • (Hash<String,Object>) 


268
269
270
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 268

def json_payload
  @json_payload
end

#labels ⇒ Hash<String,String>

Optional. A set of user-defined (key, value) data that provides additional information about the log entry. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


274
275
276
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 274

def labels
  @labels
end

#log_name ⇒ String

Required. The resource name of the log to which this log entry belongs. The format of the name is "projects/<project-id>/logs/<log-id>". Examples: "projects/my-projectid/logs/syslog", "projects/my-projectid/logs/library.googleapis.com%2Fbook_log". The log ID part of resource name must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters: [A-Za-z0-9]; and punctuation characters: forward-slash, underscore, hyphen, and period. Forward-slash (/) characters in the log ID must be URL-encoded. Corresponds to the JSON property logName

Returns:

  • (String) 


288
289
290
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 288

def log_name
  @log_name
end

#operation ⇒ Google::Apis::LoggingV2beta1::LogEntryOperation

Additional information about a potentially long-running operation with which a log entry is associated. Corresponds to the JSON property operation

Returns:



338
339
340
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 338

def operation
  @operation
end

#proto_payload ⇒ Hash<String,Object>

The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads. Corresponds to the JSON property protoPayload

Returns:

  • (Hash<String,Object>) 


317
318
319
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 317

def proto_payload
  @proto_payload
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": "12345678901234", "zone": "us-central1-a" ` Corresponds to the JSON propertyresource`

Returns:



310
311
312
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 310

def resource
  @resource
end

#severity ⇒ String

Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT. Corresponds to the JSON property severity

Returns:

  • (String) 


294
295
296
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 294

def severity
  @severity
end

#text_payload ⇒ String

The log entry payload, represented as a Unicode string (UTF-8). Corresponds to the JSON property textPayload

Returns:

  • (String) 


255
256
257
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 255

def text_payload
  @text_payload
end

#timestamp ⇒ String

Optional. The time the event described by the log entry occurred. If omitted, Stackdriver Logging will use the time the log entry is received. Corresponds to the JSON property timestamp

Returns:

  • (String) 


323
324
325
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 323

def timestamp
  @timestamp
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 345

def update!(**args)
  @text_payload = args[:text_payload] if args.key?(:text_payload)
  @http_request = args[:http_request] if args.key?(:http_request)
  @json_payload = args[:json_payload] if args.key?(:json_payload)
  @labels = args[:labels] if args.key?(:labels)
  @log_name = args[:log_name] if args.key?(:log_name)
  @severity = args[:severity] if args.key?(:severity)
  @resource = args[:resource] if args.key?(:resource)
  @proto_payload = args[:proto_payload] if args.key?(:proto_payload)
  @timestamp = args[:timestamp] if args.key?(:timestamp)
  @insert_id = args[:insert_id] if args.key?(:insert_id)
  @operation = args[:operation] if args.key?(:operation)
end