Class Client (1.6.0)

Version 1.6.0

• 1.11.0 (latest)
• 1.10.0
• 1.9.2
• 1.8.2
• 1.7.0
• 1.6.3
• 1.5.3
• 1.4.1
• 1.3.0
• 1.2.3
• 1.1.2
• 1.0.0
• 0.34.0
• 0.33.0
• 0.32.1

Client(project=None, credentials=None, _http=None, service=None, version=None, client_info=<google.api_core.gapic_v1.client_info.ClientInfo object>, client_options=None, _use_grpc=None)

Error Reporting client. Currently Error Reporting is done by creating a Logging client.

Parameters

Name	Description
project	str the project which the client acts on behalf of. If not passed falls back to the default inferred from the environment.
credentials	`google.auth.credentials.Credentials` or `NoneType` The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment.
_http	`requests.Session` (Optional) HTTP object to make requests. Can be any object that defines request() with the same interface as requests.Session.request. If not passed, an _http object is created that is bound to the credentials for the current object. This parameter should be considered private, and could change in the future.
service	str An identifier of the service, such as the name of the executable, job, or Google App Engine service name. This field is expected to have a low number of values that are relatively stable over time, as opposed to version, which can be changed whenever new code is deployed.
version	str Represents the source code version that the developer provided, which could represent a version label or a Git SHA-1 hash, for example. If the developer did not provide a version, the value is set to default.
_use_grpc	bool (Optional) Explicitly specifies whether to use the gRPC transport or HTTP. If unset, falls back to the GOOGLE_CLOUD_DISABLE_GRPC environment variable. This parameter should be considered private, and could change in the future.
client_info	`google.api_core.client_info.ClientInfo` or `google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own library or partner tool.
client_options	`google.api_core.client_options.ClientOptions` or `dict` (Optional) Client options used to set user options on the client. API Endpoint should be set through client_options.

Inheritance

builtins.object > google.cloud.client._ClientFactoryMixin > google.cloud.client.Client > builtins.object > google.cloud.client._ClientProjectMixin > google.cloud.client.ClientWithProject > Client

Properties

report_errors_api

Helper for logging-related API calls.

See https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.logs

Returns

Type	Description
`_gapic._ErrorReportingGapicApi` or `._logging._ErrorReportingLoggingAPI`	A class that implements the report errors API.

Methods

report

report(message, http_context=None, user=None)

Reports a message to Error Reporting

https://cloud.google.com/error-reporting/docs/formatting-error-messages

Parameters

Name	Description
message	str A user-supplied message to report
http_context	:class`google.cloud.error_reporting.HTTPContext` The HTTP request which was processed when the error was triggered.
user	str The user who caused or was affected by the crash. This can be a user ID, an email address, or an arbitrary token that uniquely identifies the user. When sending an error report, leave this field empty if the user was not logged in. In this case the Error Reporting system will use other data, such as remote IP address, to distinguish affected users. Example: .. code-block:: python >>> client.report("Something went wrong!")

report_exception

report_exception(http_context=None, user=None)

Reports the details of the latest exceptions to Error Reporting.

Parameters

Name	Description
http_context	:class`google.cloud.error_reporting.HTTPContext` The HTTP request which was processed when the error was triggered.
user	str The user who caused or was affected by the crash. This can be a user ID, an email address, or an arbitrary token that uniquely identifies the user. When sending an error report, leave this field empty if the user was not logged in. In this case the Error Reporting system will use other data, such as remote IP address, to distinguish affected users. Example:: >>> try: >>> raise NameError >>> except Exception: >>> client.report_exception()