As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

ErrorStatsService

class google.cloud.errorreporting_v1beta1.services.error_stats_service.ErrorStatsServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.errorreporting_v1beta1.services.error_stats_service.transports.base.ErrorStatsServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

An API for retrieving and managing error statistics as well as data for individual events.

Instantiates the error stats service client.

Parameters
  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Union[str, ErrorStatsServiceTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

static common_billing_account_path(billing_account: str)str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str

Returns a fully-qualified location string.

static common_organization_path(organization: str)str

Returns a fully-qualified organization string.

static common_project_path(project: str)str

Returns a fully-qualified project string.

async delete_events(request: Optional[google.cloud.errorreporting_v1beta1.types.error_stats_service.DeleteEventsRequest] = None, *, project_name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.errorreporting_v1beta1.types.error_stats_service.DeleteEventsResponse[source]

Deletes all error events of a given project.

Parameters
  • request (google.cloud.errorreporting_v1beta1.types.DeleteEventsRequest) – The request object. Deletes all events in the project.

  • project_name (str) –

    Required. The resource name of the Google Cloud Platform project. Written as projects/{projectID}, where {projectID} is the Google Cloud Platform project ID.

    Example: projects/my-project-123.

    This corresponds to the project_name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for deleting error events.

Return type

google.cloud.errorreporting_v1beta1.types.DeleteEventsResponse

static error_group_path(project: str, group: str)str

Returns a fully-qualified error_group string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ErrorStatsServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ErrorStatsServiceAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ErrorStatsServiceAsyncClient

get_transport_class()Type[google.cloud.errorreporting_v1beta1.services.error_stats_service.transports.base.ErrorStatsServiceTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

async list_events(request: Optional[google.cloud.errorreporting_v1beta1.types.error_stats_service.ListEventsRequest] = None, *, project_name: Optional[str] = None, group_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.errorreporting_v1beta1.services.error_stats_service.pagers.ListEventsAsyncPager[source]

Lists the specified events.

Parameters
  • request (google.cloud.errorreporting_v1beta1.types.ListEventsRequest) – The request object. Specifies a set of error events to return.

  • project_name (str) –

    Required. The resource name of the Google Cloud Platform project. Written as projects/{projectID}, where {projectID} is the Google Cloud Platform project ID.

    Example: projects/my-project-123.

    This corresponds to the project_name field on the request instance; if request is provided, this should not be set.

  • group_id (str) –

    Required. The group for which events shall be returned.

    This corresponds to the group_id field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Contains a set of requested error events. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.errorreporting_v1beta1.services.error_stats_service.pagers.ListEventsAsyncPager

async list_group_stats(request: Optional[google.cloud.errorreporting_v1beta1.types.error_stats_service.ListGroupStatsRequest] = None, *, project_name: Optional[str] = None, time_range: Optional[google.cloud.errorreporting_v1beta1.types.error_stats_service.QueryTimeRange] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.errorreporting_v1beta1.services.error_stats_service.pagers.ListGroupStatsAsyncPager[source]

Lists the specified groups.

Parameters
  • request (google.cloud.errorreporting_v1beta1.types.ListGroupStatsRequest) – The request object. Specifies a set of ErrorGroupStats to return.

  • project_name (str) –

    Required. The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud Console.

    Examples: projects/my-project-123, projects/5551234.

    This corresponds to the project_name field on the request instance; if request is provided, this should not be set.

  • time_range (google.cloud.errorreporting_v1beta1.types.QueryTimeRange) –

    Optional. List data for the given time range. If not set, a default time range is used. The field time_range_begin in the response will specify the beginning of this time range. Only ErrorGroupStats with a non-zero count in the given time range are returned, unless the request contains an explicit group_id list. If a group_id list is given, also ErrorGroupStats with zero occurrences are returned.

    This corresponds to the time_range field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Contains a set of requested error group stats. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.errorreporting_v1beta1.services.error_stats_service.pagers.ListGroupStatsAsyncPager

static parse_common_billing_account_path(path: str)Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str]

Parse a project path into its component segments.

static parse_error_group_path(path: str)Dict[str, str]

Parses a error_group path into its component segments.

property transport: google.cloud.errorreporting_v1beta1.services.error_stats_service.transports.base.ErrorStatsServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

ErrorStatsServiceTransport

class google.cloud.errorreporting_v1beta1.services.error_stats_service.ErrorStatsServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.errorreporting_v1beta1.services.error_stats_service.transports.base.ErrorStatsServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

An API for retrieving and managing error statistics as well as data for individual events.

Instantiates the error stats service client.

Parameters
  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Union[str, ErrorStatsServiceTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

  • client_info (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 client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

static common_billing_account_path(billing_account: str)str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str)str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str)str[source]

Returns a fully-qualified project string.

delete_events(request: Optional[Union[google.cloud.errorreporting_v1beta1.types.error_stats_service.DeleteEventsRequest, dict]] = None, *, project_name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.errorreporting_v1beta1.types.error_stats_service.DeleteEventsResponse[source]

Deletes all error events of a given project.

Parameters
  • request (Union[google.cloud.errorreporting_v1beta1.types.DeleteEventsRequest, dict]) – The request object. Deletes all events in the project.

  • project_name (str) –

    Required. The resource name of the Google Cloud Platform project. Written as projects/{projectID}, where {projectID} is the Google Cloud Platform project ID.

    Example: projects/my-project-123.

    This corresponds to the project_name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for deleting error events.

Return type

google.cloud.errorreporting_v1beta1.types.DeleteEventsResponse

static error_group_path(project: str, group: str)str[source]

Returns a fully-qualified error_group string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ErrorStatsServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ErrorStatsServiceClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ErrorStatsServiceClient

list_events(request: Optional[Union[google.cloud.errorreporting_v1beta1.types.error_stats_service.ListEventsRequest, dict]] = None, *, project_name: Optional[str] = None, group_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.errorreporting_v1beta1.services.error_stats_service.pagers.ListEventsPager[source]

Lists the specified events.

Parameters
  • request (Union[google.cloud.errorreporting_v1beta1.types.ListEventsRequest, dict]) – The request object. Specifies a set of error events to return.

  • project_name (str) –

    Required. The resource name of the Google Cloud Platform project. Written as projects/{projectID}, where {projectID} is the Google Cloud Platform project ID.

    Example: projects/my-project-123.

    This corresponds to the project_name field on the request instance; if request is provided, this should not be set.

  • group_id (str) –

    Required. The group for which events shall be returned.

    This corresponds to the group_id field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Contains a set of requested error events. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.errorreporting_v1beta1.services.error_stats_service.pagers.ListEventsPager

list_group_stats(request: Optional[Union[google.cloud.errorreporting_v1beta1.types.error_stats_service.ListGroupStatsRequest, dict]] = None, *, project_name: Optional[str] = None, time_range: Optional[google.cloud.errorreporting_v1beta1.types.error_stats_service.QueryTimeRange] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.errorreporting_v1beta1.services.error_stats_service.pagers.ListGroupStatsPager[source]

Lists the specified groups.

Parameters
  • request (Union[google.cloud.errorreporting_v1beta1.types.ListGroupStatsRequest, dict]) – The request object. Specifies a set of ErrorGroupStats to return.

  • project_name (str) –

    Required. The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud Console.

    Examples: projects/my-project-123, projects/5551234.

    This corresponds to the project_name field on the request instance; if request is provided, this should not be set.

  • time_range (google.cloud.errorreporting_v1beta1.types.QueryTimeRange) –

    Optional. List data for the given time range. If not set, a default time range is used. The field time_range_begin in the response will specify the beginning of this time range. Only ErrorGroupStats with a non-zero count in the given time range are returned, unless the request contains an explicit group_id list. If a group_id list is given, also ErrorGroupStats with zero occurrences are returned.

    This corresponds to the time_range field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Contains a set of requested error group stats. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.errorreporting_v1beta1.services.error_stats_service.pagers.ListGroupStatsPager

static parse_common_billing_account_path(path: str)Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str][source]

Parse a project path into its component segments.

static parse_error_group_path(path: str)Dict[str, str][source]

Parses a error_group path into its component segments.

property transport: google.cloud.errorreporting_v1beta1.services.error_stats_service.transports.base.ErrorStatsServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

ErrorStatsServiceTransport

class google.cloud.errorreporting_v1beta1.services.error_stats_service.pagers.ListEventsAsyncPager(method: Callable[[...], Awaitable[google.cloud.errorreporting_v1beta1.types.error_stats_service.ListEventsResponse]], request: google.cloud.errorreporting_v1beta1.types.error_stats_service.ListEventsRequest, response: google.cloud.errorreporting_v1beta1.types.error_stats_service.ListEventsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_events requests.

This class thinly wraps an initial google.cloud.errorreporting_v1beta1.types.ListEventsResponse object, and provides an __aiter__ method to iterate through its error_events field.

If there are more pages, the __aiter__ method will make additional ListEvents requests and continue to iterate through the error_events field on the corresponding responses.

All the usual google.cloud.errorreporting_v1beta1.types.ListEventsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.errorreporting_v1beta1.services.error_stats_service.pagers.ListEventsPager(method: Callable[[...], google.cloud.errorreporting_v1beta1.types.error_stats_service.ListEventsResponse], request: google.cloud.errorreporting_v1beta1.types.error_stats_service.ListEventsRequest, response: google.cloud.errorreporting_v1beta1.types.error_stats_service.ListEventsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_events requests.

This class thinly wraps an initial google.cloud.errorreporting_v1beta1.types.ListEventsResponse object, and provides an __iter__ method to iterate through its error_events field.

If there are more pages, the __iter__ method will make additional ListEvents requests and continue to iterate through the error_events field on the corresponding responses.

All the usual google.cloud.errorreporting_v1beta1.types.ListEventsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.errorreporting_v1beta1.services.error_stats_service.pagers.ListGroupStatsAsyncPager(method: Callable[[...], Awaitable[google.cloud.errorreporting_v1beta1.types.error_stats_service.ListGroupStatsResponse]], request: google.cloud.errorreporting_v1beta1.types.error_stats_service.ListGroupStatsRequest, response: google.cloud.errorreporting_v1beta1.types.error_stats_service.ListGroupStatsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_group_stats requests.

This class thinly wraps an initial google.cloud.errorreporting_v1beta1.types.ListGroupStatsResponse object, and provides an __aiter__ method to iterate through its error_group_stats field.

If there are more pages, the __aiter__ method will make additional ListGroupStats requests and continue to iterate through the error_group_stats field on the corresponding responses.

All the usual google.cloud.errorreporting_v1beta1.types.ListGroupStatsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.errorreporting_v1beta1.services.error_stats_service.pagers.ListGroupStatsPager(method: Callable[[...], google.cloud.errorreporting_v1beta1.types.error_stats_service.ListGroupStatsResponse], request: google.cloud.errorreporting_v1beta1.types.error_stats_service.ListGroupStatsRequest, response: google.cloud.errorreporting_v1beta1.types.error_stats_service.ListGroupStatsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_group_stats requests.

This class thinly wraps an initial google.cloud.errorreporting_v1beta1.types.ListGroupStatsResponse object, and provides an __iter__ method to iterate through its error_group_stats field.

If there are more pages, the __iter__ method will make additional ListGroupStats requests and continue to iterate through the error_group_stats field on the corresponding responses.

All the usual google.cloud.errorreporting_v1beta1.types.ListGroupStatsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters