Package google.cloud.discoveryengine.logging

Index

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

ConnectorRunErrorContext

The error payload that is populated on LRO sync APIs, including the following:

• google.cloud.discoveryengine.v1main.DataConnectorService.SetUpDataConnector
• google.cloud.discoveryengine.v1main.DataConnectorService.StartConnectorRun

Fields
operation	string The operation resource name of the LRO to sync the connector.
data_connector	string The full resource name of the DataConnector. Format: projects/*/locations/*/collections/*/dataConnector.
connector_run	string The full resource name of the Connector Run. Format: projects/*/locations/*/collections/*/dataConnector/connectorRuns/*. The connector_run_id is system-generated.
entity	string The entity to sync for the connector run.
sync_type	string The type of sync run. Can be one of the following: FULL INCREMENTAL
start_time	Timestamp The time when the connector run started.
end_time	Timestamp The time when the connector run ended.

ErrorContext

A description of the context in which an error occurred.

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.

ErrorLog

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

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.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest type.googleapis.com/google.cloud.discoveryengine.v1alpha.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.discoveryengine.v1alpha.RecommendationService.Recommend google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent
import_payload	ImportErrorContext The error payload that is populated on LRO import APIs.
connector_run_payload	ConnectorRunErrorContext The error payload that is populated on LRO connector sync APIs.

HttpRequestContext

HTTP request data that is related to a reported error.

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

ImportErrorContext

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

Fields
operation	string The operation resource name of the LRO.
gcs_path	string Google 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:
document	string The detailed content which caused the error on importing a document.
user_event	string The detailed content which caused the error on importing a user event.

ServiceContext

Describes a running service that sends errors.

Fields
service	string An identifier of the service—for example, discoveryengine.googleapis.com.

SourceLocation

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

Fields
function_name	string Human-readable name of a function or method—for example, google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend.