def get_group(
self,
group_name,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Get the specified group.
Example:
>>> from google.cloud import errorreporting_v1beta1
>>>
>>> client = errorreporting_v1beta1.ErrorGroupServiceClient()
>>>
>>> group_name = client.group_path('[PROJECT]', '[GROUP]')
>>>
>>> response = client.get_group(group_name)
Args:
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 not
be retried.
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.
Returns:
A :class:`~google.cloud.errorreporting_v1beta1.types.ErrorGroup` instance.
Raises:
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.
"""
# Wrap the transport method to add retry and timeout logic.
if "get_group" not in self._inner_api_calls:
self._inner_api_calls[
"get_group"] = google.api_core.gapic_v1.method.wrap_method(
self.transport.get_group,
default_retry=self._method_configs["GetGroup"].retry,
default_timeout=self._method_configs["GetGroup"].timeout,
client_info=self._client_info,
)
request = error_group_service_pb2.GetGroupRequest(
group_name=group_name)
return self._inner_api_calls["get_group"](request,
retry=retry,
timeout=timeout,
metadata=metadata)
def test_get_group(self):
# Setup Expected Response
name = "name3373707"
group_id = "groupId506361563"
expected_response = {"name": name, "group_id": group_id}
expected_response = common_pb2.ErrorGroup(**expected_response)
# Mock the API response
channel = ChannelStub(responses=[expected_response])
patch = mock.patch("google.api_core.grpc_helpers.create_channel")
with patch as create_channel:
create_channel.return_value = channel
client = errorreporting_v1beta1.ErrorGroupServiceClient()
# Setup Request
group_name = client.group_path("[PROJECT]", "[GROUP]")
response = client.get_group(group_name)
assert expected_response == response
assert len(channel.requests) == 1
expected_request = error_group_service_pb2.GetGroupRequest(
group_name=group_name)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def get_group(self,
group_name,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None):
"""
Get the specified group.
Example:
>>> from google.cloud import errorreporting_v1beta1
>>>
>>> client = errorreporting_v1beta1.ErrorGroupServiceClient()
>>>
>>> group_name = client.group_path('[PROJECT]', '[GROUP]')
>>>
>>> response = client.get_group(group_name)
Args:
group_name (str): [Required] The group resource name. Written as
<code>projects/<var>projectID</var>/groups/<var>group_name</var></code>.
Call
<a href=\"/error-reporting/reference/rest/v1beta1/projects.groupStats/list\">
<code>groupStats.list</code></a> to return a list of groups belonging to
this project.
Example: <code>projects/my-project-123/groups/my-group</code>
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
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.
Returns:
A :class:`~google.cloud.errorreporting_v1beta1.types.ErrorGroup` instance.
Raises:
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.
"""
if metadata is None:
metadata = []
metadata = list(metadata)
request = error_group_service_pb2.GetGroupRequest(
group_name=group_name, )
return self._get_group(request,
retry=retry,
timeout=timeout,
metadata=metadata)
def test_get_group(self):
# Setup Expected Response
name = 'name3373707'
group_id = 'groupId506361563'
expected_response = {'name': name, 'group_id': group_id}
expected_response = common_pb2.ErrorGroup(**expected_response)
# Mock the API response
channel = ChannelStub(responses=[expected_response])
client = errorreporting_v1beta1.ErrorGroupServiceClient(
channel=channel)
# Setup Request
group_name = client.group_path('[PROJECT]', '[GROUP]')
response = client.get_group(group_name)
assert expected_response == response
assert len(channel.requests) == 1
expected_request = error_group_service_pb2.GetGroupRequest(
group_name=group_name)
actual_request = channel.requests[0][1]
assert expected_request == actual_request