Class: Google::Apis::LoggingV2::LogEntry

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

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



756
757
758
 
# File 'generated/google/apis/logging_v2/classes.rb', line 756

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

Instance Attribute Details

#http_request ⇒ Google::Apis::LoggingV2::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:



695
696
697
 
# File 'generated/google/apis/logging_v2/classes.rb', line 695

def http_request
  @http_request
end

#insert_id ⇒ String

Optional. A unique identifier for the log entry. If you provide a value, then Stackdriver Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging will insert its own unique identifier. The insert_id is used to order log entries that have the same timestamp value. Corresponds to the JSON property insertId

Returns:

  • (String) 


717
718
719
 
# File 'generated/google/apis/logging_v2/classes.rb', line 717

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


701
702
703
 
# File 'generated/google/apis/logging_v2/classes.rb', line 701

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


734
735
736
 
# File 'generated/google/apis/logging_v2/classes.rb', line 734

def labels
  @labels
end

#log_name ⇒ String

Required. The resource name of the log to which this log entry belongs: "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 within log_name. Example: "organizations/ 1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results. Corresponds to the JSON property logName

Returns:

  • (String) 


672
673
674
 
# File 'generated/google/apis/logging_v2/classes.rb', line 672

def log_name
  @log_name
end

#operation ⇒ Google::Apis::LoggingV2::LogEntryOperation

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

Returns:



707
708
709
 
# File 'generated/google/apis/logging_v2/classes.rb', line 707

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


728
729
730
 
# File 'generated/google/apis/logging_v2/classes.rb', line 728

def proto_payload
  @proto_payload
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:



688
689
690
 
# File 'generated/google/apis/logging_v2/classes.rb', line 688

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) 


748
749
750
 
# File 'generated/google/apis/logging_v2/classes.rb', line 748

def severity
  @severity
end

#source_location ⇒ Google::Apis::LoggingV2::LogEntrySourceLocation

Additional information about the source code location that produced the log entry. Corresponds to the JSON property sourceLocation

Returns:



754
755
756
 
# File 'generated/google/apis/logging_v2/classes.rb', line 754

def source_location
  @source_location
end

#text_payload ⇒ String

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

Returns:

  • (String) 


722
723
724
 
# File 'generated/google/apis/logging_v2/classes.rb', line 722

def text_payload
  @text_payload
end

#timestamp ⇒ String

Optional. The time the event described by the log entry occurred. If omitted in a new log entry, Stackdriver Logging will insert the time the log entry is received. Stackdriver Logging might reject log entries whose time stamps are more than a couple of hours in the future. Log entries with time stamps in the past are accepted. Corresponds to the JSON property timestamp

Returns:

  • (String) 


654
655
656
 
# File 'generated/google/apis/logging_v2/classes.rb', line 654

def timestamp
  @timestamp
end

#trace ⇒ String

Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to // tracing.googleapis.com. Example: projects/my-projectid/traces/ 06796866738c859f2f19b7cfb3214824 Corresponds to the JSON property trace

Returns:

  • (String) 


742
743
744
 
# File 'generated/google/apis/logging_v2/classes.rb', line 742

def trace
  @trace
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
 
# File 'generated/google/apis/logging_v2/classes.rb', line 761

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