def test_list_instances(self): # Setup Expected Response next_page_token = "" instances_element = {} instances = [instances_element] expected_response = { "next_page_token": next_page_token, "instances": instances } expected_response = cloud_redis_pb2.ListInstancesResponse( **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 = redis_v1.CloudRedisClient() # Setup Request parent = client.location_path("[PROJECT]", "[LOCATION]") paged_list_response = client.list_instances(parent) resources = list(paged_list_response) assert len(resources) == 1 assert expected_response.instances[0] == resources[0] assert len(channel.requests) == 1 expected_request = cloud_redis_pb2.ListInstancesRequest(parent=parent) actual_request = channel.requests[0][1] assert expected_request == actual_request
def test_list_instances(self): # Setup Expected Response next_page_token = '' instances_element = {} instances = [instances_element] expected_response = { 'next_page_token': next_page_token, 'instances': instances } expected_response = cloud_redis_pb2.ListInstancesResponse( **expected_response) # Mock the API response channel = ChannelStub(responses=[expected_response]) client = redis_v1.CloudRedisClient(channel=channel) # Setup Request parent = client.location_path('[PROJECT]', '[LOCATION]') paged_list_response = client.list_instances(parent) resources = list(paged_list_response) assert len(resources) == 1 assert expected_response.instances[0] == resources[0] assert len(channel.requests) == 1 expected_request = cloud_redis_pb2.ListInstancesRequest(parent=parent) actual_request = channel.requests[0][1] assert expected_request == actual_request
def list_instances( self, parent, page_size=None, retry=google.api_core.gapic_v1.method.DEFAULT, timeout=google.api_core.gapic_v1.method.DEFAULT, metadata=None, ): """ Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: \* ``projects/{project_id}/locations/{location_id}`` If ``location_id`` is specified as ``-`` (wildcard), then all regions available to the project are queried, and the results are aggregated. Example: >>> from google.cloud import redis_v1 >>> >>> client = redis_v1.CloudRedisClient() >>> >>> parent = client.location_path('[PROJECT]', '[LOCATION]') >>> >>> # Iterate over all results >>> for element in client.list_instances(parent): ... # process element ... pass >>> >>> >>> # Alternatively: >>> >>> # Iterate over results one page at a time >>> for page in client.list_instances(parent).pages: ... for element in page: ... # process element ... pass Args: parent (str): Required. The resource name of the instance location using the form: ``projects/{project_id}/locations/{location_id}`` where ``location_id`` refers to a GCP region page_size (int): The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page. 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.gax.PageIterator` instance. By default, this is an iterable of :class:`~google.cloud.redis_v1.types.Instance` instances. This object can also be configured to iterate over the pages of the response through the `options` parameter. 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 "list_instances" not in self._inner_api_calls: self._inner_api_calls[ "list_instances"] = google.api_core.gapic_v1.method.wrap_method( self.transport.list_instances, default_retry=self._method_configs["ListInstances"].retry, default_timeout=self._method_configs["ListInstances"]. timeout, client_info=self._client_info, ) request = cloud_redis_pb2.ListInstancesRequest(parent=parent, page_size=page_size) iterator = google.api_core.page_iterator.GRPCIterator( client=None, method=functools.partial( self._inner_api_calls["list_instances"], retry=retry, timeout=timeout, metadata=metadata, ), request=request, items_field="instances", request_token_field="page_token", response_token_field="next_page_token", ) return iterator