Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineLoggingErrorLog

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/representations.rb

Overview

An error log which is reported to the Error Reporting system.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineLoggingErrorLog

Returns a new instance of GoogleCloudDiscoveryengineLoggingErrorLog.



156
157
158
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 156

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

Instance Attribute Details

#context ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineLoggingErrorContext

A description of the context in which an error occurred. Corresponds to the JSON property context

Returns:



106
107
108
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 106

def context
  @context
end

#import_payload ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineLoggingImportErrorContext

The error payload that is populated on LRO import APIs, including the following: * google.cloud.discoveryengine.v1alpha.DocumentService. ImportDocuments * google.cloud.discoveryengine.v1alpha.UserEventService. ImportUserEvents Corresponds to the JSON property importPayload

Returns:



114
115
116
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 114

def import_payload
  @import_payload
end

#message ⇒ String

A message describing the error. Corresponds to the JSON property message

Returns:

  • (String) 


119
120
121
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 119

def message
  @message
end

#request_payload ⇒ Hash<String,Object>

The API request payload, represented as a protocol buffer. Most API request types are supported—for example: * type.googleapis.com/google.cloud. discoveryengine.v1alpha.DocumentService.CreateDocumentRequest * type. googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService. WriteUserEventRequest Corresponds to the JSON property requestPayload

Returns:

  • (Hash<String,Object>) 


128
129
130
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 128

def request_payload
  @request_payload
end

#response_payload ⇒ Hash<String,Object>

The API response payload, represented as a protocol buffer. This is used to log some "soft errors", where the response is valid but we consider there are some quality issues like unjoined events. The following API responses are supported, and no PII is included: * google.cloud.discoveryengine.v1alpha. RecommendationService.Recommend * google.cloud.discoveryengine.v1alpha. UserEventService.WriteUserEvent * google.cloud.discoveryengine.v1alpha. UserEventService.CollectUserEvent Corresponds to the JSON property responsePayload

Returns:

  • (Hash<String,Object>) 


139
140
141
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 139

def response_payload
  @response_payload
end

#service_context ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineLoggingServiceContext

Describes a running service that sends errors. Corresponds to the JSON property serviceContext

Returns:



144
145
146
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 144

def service_context
  @service_context
end

#status ⇒ Google::Apis::DiscoveryengineV1::GoogleRpcStatus

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property status

Returns:



154
155
156
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 154

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



161
162
163
164
165
166
167
168
169
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 161

def update!(**args)
  @context = args[:context] if args.key?(:context)
  @import_payload = args[:import_payload] if args.key?(:import_payload)
  @message = args[:message] if args.key?(:message)
  @request_payload = args[:request_payload] if args.key?(:request_payload)
  @response_payload = args[:response_payload] if args.key?(:response_payload)
  @service_context = args[:service_context] if args.key?(:service_context)
  @status = args[:status] if args.key?(:status)
end