Class ErrorStatsServiceClient

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>)

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

Inheritance

builtins.object > ErrorStatsServiceClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
ErrorStatsServiceTransportThe transport used by the client instance.

Methods

ErrorStatsServiceClient

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>)

Instantiates the error stats service client.

Parameters
NameDescription
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.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

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!

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

delete_events

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

Deletes all error events of a given project.

from google.cloud import errorreporting_v1beta1

def sample_delete_events():
    # Create a client
    client = errorreporting_v1beta1.ErrorStatsServiceClient()

    # Initialize request argument(s)
    request = errorreporting_v1beta1.DeleteEventsRequest(
        project_name="project_name_value",
    )

    # Make the request
    response = client.delete_events(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
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 <https://support.google.com/cloud/answer/6158840>__. 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
TypeDescription
google.cloud.errorreporting_v1beta1.types.DeleteEventsResponseResponse message for deleting error events.

error_group_path

error_group_path(project: str, group: str)

Returns a fully-qualified error_group string.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
ErrorStatsServiceClientThe constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
ErrorStatsServiceClientThe constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
ErrorStatsServiceClientThe constructed client.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
NameDescription
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf any errors happen.
Returns
TypeDescription
Tuple[str, Callable[[], Tuple[bytes, bytes]]]returns the API endpoint and the client cert source to use.

list_events

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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists the specified events.

from google.cloud import errorreporting_v1beta1

def sample_list_events():
    # Create a client
    client = errorreporting_v1beta1.ErrorStatsServiceClient()

    # Initialize request argument(s)
    request = errorreporting_v1beta1.ListEventsRequest(
        project_name="project_name_value",
        group_id="group_id_value",
    )

    # Make the request
    page_result = client.list_events(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
NameDescription
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 <https://support.google.com/cloud/answer/6158840>__. 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
TypeDescription
google.cloud.errorreporting_v1beta1.services.error_stats_service.pagers.ListEventsPagerContains a set of requested error events. Iterating over this object will yield results and resolve additional pages automatically.

list_group_stats

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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists the specified groups.

from google.cloud import errorreporting_v1beta1

def sample_list_group_stats():
    # Create a client
    client = errorreporting_v1beta1.ErrorStatsServiceClient()

    # Initialize request argument(s)
    request = errorreporting_v1beta1.ListGroupStatsRequest(
        project_name="project_name_value",
    )

    # Make the request
    page_result = client.list_group_stats(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
NameDescription
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 <https://support.google.com/cloud/answer/6158840>__. 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
TypeDescription
google.cloud.errorreporting_v1beta1.services.error_stats_service.pagers.ListGroupStatsPagerContains a set of requested error group stats. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_error_group_path

parse_error_group_path(path: str)

Parses a error_group path into its component segments.