async def list_instances( self, request: appengine.ListInstancesRequest = None, *, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListInstancesAsyncPager: r"""Lists the instances of a version. Tip: To aggregate details about instances over time, see the `Stackdriver Monitoring API <https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list>`__. Args: request (:class:`google.cloud.appengine_admin_v1.types.ListInstancesRequest`): The request object. Request message for `Instances.ListInstances`. 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.appengine_admin_v1.services.instances.pagers.ListInstancesAsyncPager: Response message for Instances.ListInstances. Iterating over this object will yield results and resolve additional pages automatically. """ # Create or coerce a protobuf request object. request = appengine.ListInstancesRequest(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.list_instances, 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((("parent", request.parent),)), ) # 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.ListInstancesAsyncPager( method=rpc, request=request, response=response, metadata=metadata, ) # Done; return the response. return response
def __init__(self, method: Callable[..., appengine.ListInstancesResponse], request: appengine.ListInstancesRequest, response: appengine.ListInstancesResponse, *, 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.appengine_admin_v1.types.ListInstancesRequest): The initial request object. response (google.cloud.appengine_admin_v1.types.ListInstancesResponse): 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 = appengine.ListInstancesRequest(request) self._response = response self._metadata = metadata
def list_instances( self, request: appengine.ListInstancesRequest = None, *, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListInstancesPager: r"""Lists the instances of a version. Tip: To aggregate details about instances over time, see the `Stackdriver Monitoring API <https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list>`__. Args: request (google.cloud.appengine_admin_v1.types.ListInstancesRequest): The request object. Request message for `Instances.ListInstances`. 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.appengine_admin_v1.services.instances.pagers.ListInstancesPager: Response message for Instances.ListInstances. 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 appengine.ListInstancesRequest. # There's no risk of modifying the input as we've already verified # there are no flattened fields. if not isinstance(request, appengine.ListInstancesRequest): request = appengine.ListInstancesRequest(request) # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.list_instances] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), ) # 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.ListInstancesPager( method=rpc, request=request, response=response, metadata=metadata, ) # Done; return the response. return response