Class: Google::Apis::RetailV2alpha::GoogleCloudRetailLoggingErrorLog

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

Overview

An error log which is reported to the Error Reporting system. This proto a superset of google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailLoggingErrorLog

Returns a new instance of GoogleCloudRetailLoggingErrorLog.



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

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

Instance Attribute Details

#context ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailLoggingErrorContext

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

Returns:



107
108
109
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 107

def context
  @context
end

#import_payload ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailLoggingImportErrorContext

The error payload that is populated on LRO import APIs, including "google. cloud.retail.v2.ProductService.ImportProducts" and "google.cloud.retail.v2. EventService.ImportUserEvents". Corresponds to the JSON property importPayload

Returns:



114
115
116
 
# File 'lib/google/apis/retail_v2alpha/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/retail_v2alpha/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.retail.v2. ProductService.CreateProductRequest" "type.googleapis.com/google.cloud.retail. v2.UserEventService.WriteUserEventRequest" Corresponds to the JSON property requestPayload

Returns:

  • (Hash<String,Object>) 


127
128
129
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 127

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.retail.v2.PredictionService. Predict" "google.cloud.retail.v2.UserEventService.WriteUserEvent" "google. cloud.retail.v2.UserEventService.CollectUserEvent" Corresponds to the JSON property responsePayload

Returns:

  • (Hash<String,Object>) 


137
138
139
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 137

def response_payload
  @response_payload
end

#service_context ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailLoggingServiceContext

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

Returns:



142
143
144
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 142

def service_context
  @service_context
end

#status ⇒ Google::Apis::RetailV2alpha::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:



152
153
154
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 152

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



159
160
161
162
163
164
165
166
167
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 159

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