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



889
890
891
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 889

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:



808
809
810
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 808

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) 


838
839
840
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 838

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


830
831
832
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 830

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


869
870
871
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 869

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) 


801
802
803
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 801

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:



844
845
846
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 844

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


855
856
857
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 855

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:



824
825
826
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 824

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) 


875
876
877
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 875

def severity
  @severity
end

#source_location ⇒ Google::Apis::LoggingV2beta1::LogEntrySourceLocation

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

Returns:



881
882
883
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 881

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) 


849
850
851
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 849

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) 


887
888
889
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 887

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) 


863
864
865
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 863

def trace
  @trace
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 894

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