Retail is being renamed to Vertex AI Search for retail. We are in the process of updating content to reflect the new branding.

Package google.cloud.retail.logging

Index

ErrorContext (message)
ErrorLog (message)
HttpRequestContext (message)
ImportErrorContext (message)
ServiceContext (message)
SourceLocation (message)

ErrorContext

A description of the context in which an error occurred.

Fields

Fields
`http_request`	`HttpRequestContext` The HTTP request which was processed when the error was triggered.
`report_location`	`SourceLocation` The location in the source code where the decision was made to report the error, usually the place where it was logged.

http_request

HttpRequestContext

The HTTP request which was processed when the error was triggered.

report_location

SourceLocation

The location in the source code where the decision was made to report the error, usually the place where it was logged.

ErrorLog

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

Fields
`service_context`	`ServiceContext` The service context in which this error has occurred.
`context`	`ErrorContext` A description of the context in which the error occurred.
`message`	`string` A message describing the error.
`status`	`Status` The RPC status associated with the error log.
`request_payload`	`Struct` 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"
`response_payload`	`Struct` 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"
`import_payload`	`ImportErrorContext` The error payload that is populated on LRO import APIs.

HttpRequestContext

HTTP request data that is related to a reported error.

Fields

Fields
`response_status_code`	`int32` The HTTP response status code for the request.

response_status_code

int32

The HTTP response status code for the request.

ImportErrorContext

The error payload that is populated on LRO import APIs, including "google.cloud.retail.v2.ProductService.ImportProducts" and "google.cloud.retail.v2.EventService.ImportUserEvents".

Fields
`operation_name`	`string` The operation resource name of the LRO.
`gcs_path`	`string` Cloud Storage file path of the import source. Can be set for batch operation error.
`line_number`	`string` Line number of the content in file. Should be empty for permission or batch operation error.
Union field `line_content`. Detailed content which caused the error. Should be empty for permission or batch operation error. `line_content` can be only one of the following:
`catalog_item`	`string` The detailed content which caused the error on importing a catalog item.
`product`	`string` The detailed content which caused the error on importing a product.
`user_event`	`string` The detailed content which caused the error on importing a user event.

ServiceContext

Describes a running service that sends errors.

Fields

Fields
`service`	`string` An identifier of the service. For example, "retail.googleapis.com".

service

string

An identifier of the service. For example, "retail.googleapis.com".

SourceLocation

Indicates a location in the source code of the service for which errors are reported.

Fields

Fields
`function_name`	`string` Human-readable name of a function or method. For example, "google.cloud.retail.v2.UserEventService.ImportUserEvents".

function_name

string

Human-readable name of a function or method. For example, "google.cloud.retail.v2.UserEventService.ImportUserEvents".