def __init__(self,
method: Callable[..., metric_service.ListTimeSeriesResponse],
request: metric_service.ListTimeSeriesRequest,
response: metric_service.ListTimeSeriesResponse,
*,
metadata: Sequence[Tuple[str, str]] = ()):
"""Instantiate the pager.
Args:
method (Callable): The method that was originally called, and
which instantiated this pager.
request (:class:`~.metric_service.ListTimeSeriesRequest`):
The initial request object.
response (:class:`~.metric_service.ListTimeSeriesResponse`):
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.ListTimeSeriesRequest(request)
self._response = response
self._metadata = metadata
def list_time_series(
self,
request: metric_service.ListTimeSeriesRequest = None,
*,
name: str = None,
filter: str = None,
interval: common.TimeInterval = None,
view: metric_service.ListTimeSeriesRequest.TimeSeriesView = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListTimeSeriesPager:
r"""Lists time series that match a filter. This method
does not require a Workspace.
Args:
request (:class:`~.metric_service.ListTimeSeriesRequest`):
The request object. The `ListTimeSeries` request.
name (:class:`str`):
Required. The project on which to execute the request.
The format is:
::
projects/[PROJECT_ID_OR_NUMBER]
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
filter (:class:`str`):
Required. A `monitoring
filter <https://cloud.google.com/monitoring/api/v3/filters>`__
that specifies which time series should be returned. The
filter must specify a single metric type, and can
additionally specify metric labels and other
information. For example:
::
metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
metric.labels.instance_name = "my-instance-name".
This corresponds to the ``filter`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
interval (:class:`~.common.TimeInterval`):
Required. The time interval for which
results should be returned. Only time
series that contain data points in the
specified interval are included in the
response.
This corresponds to the ``interval`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
view (:class:`~.metric_service.ListTimeSeriesRequest.TimeSeriesView`):
Required. Specifies which information
is returned about the time series.
This corresponds to the ``view`` 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:
~.pagers.ListTimeSeriesPager:
The ``ListTimeSeries`` response.
Iterating over this object will yield results and
resolve additional pages automatically.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([name, filter, interval, view])
if request is not None and has_flattened_params:
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
# Minor optimization to avoid making a copy if the user passes
# in a metric_service.ListTimeSeriesRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, metric_service.ListTimeSeriesRequest):
request = metric_service.ListTimeSeriesRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
if filter is not None:
request.filter = filter
if interval is not None:
request.interval = interval
if view is not None:
request.view = view
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.list_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.ListTimeSeriesPager(
method=rpc,
request=request,
response=response,
metadata=metadata,
)
# Done; return the response.
return response
async def list_time_series(
self,
request: metric_service.ListTimeSeriesRequest = None,
*,
name: str = None,
filter: str = None,
interval: common.TimeInterval = None,
view: metric_service.ListTimeSeriesRequest.TimeSeriesView = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListTimeSeriesAsyncPager:
r"""Lists time series that match a filter. This method
does not require a Workspace.
Args:
request (:class:`google.cloud.monitoring_v3.types.ListTimeSeriesRequest`):
The request object. The `ListTimeSeries` request.
name (:class:`str`):
Required. The project, organization or folder on which
to execute the request. The format is:
::
projects/[PROJECT_ID_OR_NUMBER]
organizations/[ORGANIZATION_ID]
folders/[FOLDER_ID]
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
filter (:class:`str`):
Required. A `monitoring
filter <https://cloud.google.com/monitoring/api/v3/filters>`__
that specifies which time series should be returned. The
filter must specify a single metric type, and can
additionally specify metric labels and other
information. For example:
::
metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
metric.labels.instance_name = "my-instance-name"
This corresponds to the ``filter`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
interval (:class:`google.cloud.monitoring_v3.types.TimeInterval`):
Required. The time interval for which
results should be returned. Only time
series that contain data points in the
specified interval are included in the
response.
This corresponds to the ``interval`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
view (:class:`google.cloud.monitoring_v3.types.ListTimeSeriesRequest.TimeSeriesView`):
Required. Specifies which information
is returned about the time series.
This corresponds to the ``view`` 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:
google.cloud.monitoring_v3.services.metric_service.pagers.ListTimeSeriesAsyncPager:
The ListTimeSeries response.
Iterating over this object will yield results and
resolve additional pages automatically.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([name, filter, interval, view])
if request is not None and has_flattened_params:
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
request = metric_service.ListTimeSeriesRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
if filter is not None:
request.filter = filter
if interval is not None:
request.interval = interval
if view is not None:
request.view = view
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.list_time_series,
default_retry=retries.Retry(
initial=0.1,
maximum=30.0,
multiplier=1.3,
predicate=retries.if_exception_type(
core_exceptions.DeadlineExceeded,
core_exceptions.ServiceUnavailable,
),
deadline=30.0,
),
default_timeout=30.0,
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.ListTimeSeriesAsyncPager(
method=rpc,
request=request,
response=response,
metadata=metadata,
)
# Done; return the response.
return response
