Class ErrorGroupServiceClient (0.32.1)

Version 0.32.1

• 1.11.1 (latest)
• 1.11.0
• 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

ErrorGroupServiceClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

Service for retrieving and updating individual error groups.

Methods

ErrorGroupServiceClient

ErrorGroupServiceClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

Constructor.

Parameters

Name	Description
channel	grpc.Channel DEPRECATED. A Channel instance through which to make calls. This argument is mutually exclusive with credentials; providing both will raise an exception.
credentials	google.auth.credentials.Credentials 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. This argument is mutually exclusive with providing a transport instance to transport; doing so will raise an exception.
client_config	dict DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is 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.
client_options	Union[dict, google.api_core.client_options.ClientOptions] Client options used to set user options on the client. API Endpoint should be set through client_options.

from_service_account_file

from_service_account_file(filename, *args, **kwargs)

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

Parameter

Name	Description
filename	str The path to the service account private key json file.

Returns

Type	Description
ErrorGroupServiceClient	The constructed client.

from_service_account_json

from_service_account_json(filename, *args, **kwargs)

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

Parameter

Name	Description
filename	str The path to the service account private key json file.

Returns

Type	Description
ErrorGroupServiceClient	The constructed client.

get_group

get_group(group_name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Get the specified group.

.. rubric:: Example

from google.cloud import errorreporting_v1beta1

client = errorreporting_v1beta1.ErrorGroupServiceClient()

group_name = client.group_path('[PROJECT]', '[GROUP]')

response = client.get_group(group_name)

Parameters

Name	Description
group_name	str [Required] The group resource name. Written as projects/projectID/groups/group_name. Call groupStats.list to return a list of groups belonging to this project. Example: projects/my-project-123/groups/my-group
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions

Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

group_path

group_path(project, group)

Return a fully-qualified group string.

update_group

update_group(group, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Replace the data for the specified group. Fails if the group does not exist.

.. rubric:: Example

from google.cloud import errorreporting_v1beta1

client = errorreporting_v1beta1.ErrorGroupServiceClient()

TODO: Initialize group:

group = {}

response = client.update_group(group)

Parameters

Name	Description
group	Union[dict, ErrorGroup] [Required] The group which replaces the resource on the server. If a dict is provided, it must be of the same form as the protobuf message ErrorGroup
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions

Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.