async def test_query_time_series_field_headers_async():
client = QueryServiceAsyncClient(
credentials=credentials.AnonymousCredentials(), )
# Any value that is part of the HTTP/1.1 URI should be sent as
# a field header. Set these to a non-empty value.
request = metric_service.QueryTimeSeriesRequest()
request.name = "name/value"
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.query_time_series),
"__call__") as call:
call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(
metric_service.QueryTimeSeriesResponse())
await client.query_time_series(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls)
_, args, _ = call.mock_calls[0]
assert args[0] == request
# Establish that the field header was sent.
_, _, kw = call.mock_calls[0]
assert (
"x-goog-request-params",
"name=name/value",
) in kw["metadata"]
async def test_query_time_series_async(
transport: str = "grpc_asyncio",
request_type=metric_service.QueryTimeSeriesRequest):
client = QueryServiceAsyncClient(
credentials=credentials.AnonymousCredentials(),
transport=transport,
)
# Everything is optional in proto3 as far as the runtime is concerned,
# and we are mocking out the actual API, so just send an empty request.
request = request_type()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.query_time_series),
"__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(
metric_service.QueryTimeSeriesResponse(
next_page_token="next_page_token_value", ))
response = await client.query_time_series(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls)
_, args, _ = call.mock_calls[0]
assert args[0] == metric_service.QueryTimeSeriesRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, pagers.QueryTimeSeriesAsyncPager)
assert response.next_page_token == "next_page_token_value"
def query_time_series(
self,
request: metric_service.QueryTimeSeriesRequest = None,
*,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.QueryTimeSeriesPager:
r"""Queries time series using Monitoring Query Language.
This method does not require a Workspace.
Args:
request (google.cloud.monitoring_v3.types.QueryTimeSeriesRequest):
The request object. The `QueryTimeSeries` request.
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:
google.cloud.monitoring_v3.services.query_service.pagers.QueryTimeSeriesPager:
The QueryTimeSeries response.
Iterating over this object will yield results and
resolve additional pages automatically.
"""
# Create or coerce a protobuf request object.
# Minor optimization to avoid making a copy if the user passes
# in a metric_service.QueryTimeSeriesRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, metric_service.QueryTimeSeriesRequest):
request = metric_service.QueryTimeSeriesRequest(request)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.query_time_series]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# This method is paged; wrap the response in a pager, which provides
# an `__iter__` convenience method.
response = pagers.QueryTimeSeriesPager(
method=rpc, request=request, response=response, metadata=metadata,
)
# Done; return the response.
return response
async def query_time_series(
self,
request: metric_service.QueryTimeSeriesRequest = None,
*,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.QueryTimeSeriesAsyncPager:
r"""Queries time series using Monitoring Query Language.
This method does not require a Workspace.
Args:
request (:class:`google.cloud.monitoring_v3.types.QueryTimeSeriesRequest`):
The request object. The `QueryTimeSeries` request.
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:
google.cloud.monitoring_v3.services.query_service.pagers.QueryTimeSeriesAsyncPager:
The QueryTimeSeries response.
Iterating over this object will yield results and
resolve additional pages automatically.
"""
# Create or coerce a protobuf request object.
request = metric_service.QueryTimeSeriesRequest(request)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.query_time_series,
default_timeout=None,
client_info=DEFAULT_CLIENT_INFO,
)
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# This method is paged; wrap the response in a pager, which provides
# an `__aiter__` convenience method.
response = pagers.QueryTimeSeriesAsyncPager(
method=rpc, request=request, response=response, metadata=metadata,
)
# Done; return the response.
return response
def test_query_time_series_empty_call():
# This test is a coverage failsafe to make sure that totally empty calls,
# i.e. request == None and no flattened fields passed, work.
client = QueryServiceClient(
credentials=credentials.AnonymousCredentials(),
transport="grpc",
)
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.query_time_series),
"__call__") as call:
client.query_time_series()
call.assert_called()
_, args, _ = call.mock_calls[0]
assert args[0] == metric_service.QueryTimeSeriesRequest()
def __init__(self,
method: Callable[..., metric_service.QueryTimeSeriesResponse],
request: metric_service.QueryTimeSeriesRequest,
response: metric_service.QueryTimeSeriesResponse,
*,
metadata: Sequence[Tuple[str, str]] = ()):
"""Instantiate the pager.
Args:
method (Callable): The method that was originally called, and
which instantiated this pager.
request (google.cloud.monitoring_v3.types.QueryTimeSeriesRequest):
The initial request object.
response (google.cloud.monitoring_v3.types.QueryTimeSeriesResponse):
The initial response object.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
"""
self._method = method
self._request = metric_service.QueryTimeSeriesRequest(request)
self._response = response
self._metadata = metadata