ErrorGroupServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.errorreporting_v1beta1.services.error_group_service.transports.base.ErrorGroupServiceTransport]] = 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>)
Service for retrieving and updating individual error groups.
Properties
transport
Returns the transport used by the client instance.
Type | Description |
ErrorGroupServiceTransport | The transport used by the client instance. |
Methods
ErrorGroupServiceClient
ErrorGroupServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.errorreporting_v1beta1.services.error_group_service.transports.base.ErrorGroupServiceTransport]] = 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 group service client.
Name | Description |
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, ErrorGroupServiceTransport]
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 |
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 |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
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.
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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
ErrorGroupServiceClient | The 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.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
ErrorGroupServiceClient | The 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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
ErrorGroupServiceClient | The constructed client. |
get_group
get_group(request: Optional[Union[google.cloud.errorreporting_v1beta1.types.error_group_service.GetGroupRequest, dict]] = None, *, group_name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Get the specified group.
Name | Description |
request |
Union[google.cloud.errorreporting_v1beta1.types.GetGroupRequest, dict]
The request object. A request to return an individual group. |
group_name |
str
Required. The group resource name. Written as |
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. |
Type | Description |
google.cloud.errorreporting_v1beta1.types.ErrorGroup | Description of a group of similar error events. |
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.
update_group
update_group(request: Optional[Union[google.cloud.errorreporting_v1beta1.types.error_group_service.UpdateGroupRequest, dict]] = None, *, group: Optional[google.cloud.errorreporting_v1beta1.types.common.ErrorGroup] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Replace the data for the specified group. Fails if the group does not exist.
Name | Description |
request |
Union[google.cloud.errorreporting_v1beta1.types.UpdateGroupRequest, dict]
The request object. A request to replace the existing data for the given group. |
group |
google.cloud.errorreporting_v1beta1.types.ErrorGroup
Required. The group which replaces the resource on the server. This corresponds to the |
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. |
Type | Description |
google.cloud.errorreporting_v1beta1.types.ErrorGroup | Description of a group of similar error events. |