def test_list_companies(self):
# Setup Expected Response
next_page_token = ""
companies_element = {}
companies = [companies_element]
expected_response = {"next_page_token": next_page_token, "companies": companies}
expected_response = company_service_pb2.ListCompaniesResponse(
**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 = talent_v4beta1.CompanyServiceClient()
# Setup Request
parent = client.project_path("[PROJECT]")
paged_list_response = client.list_companies(parent)
resources = list(paged_list_response)
assert len(resources) == 1
assert expected_response.companies[0] == resources[0]
assert len(channel.requests) == 1
expected_request = company_service_pb2.ListCompaniesRequest(parent=parent)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def list_companies(
self,
parent,
page_size=None,
require_open_jobs=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Lists all companies associated with the project.
Example:
>>> from google.cloud import talent_v4beta1
>>>
>>> client = talent_v4beta1.CompanyServiceClient()
>>>
>>> parent = client.tenant_path('[PROJECT]', '[TENANT]')
>>>
>>> # Iterate over all results
>>> for element in client.list_companies(parent):
... # process element
... pass
>>>
>>>
>>> # Alternatively:
>>>
>>> # Iterate over results one page at a time
>>> for page in client.list_companies(parent).pages:
... for element in page:
... # process element
... pass
Args:
parent (str): Required.
Resource name of the tenant under which the company is created.
The format is "projects/{project\_id}/tenants/{tenant\_id}", for
example, "projects/api-test-project/tenant/foo".
Tenant id is optional and the default tenant is used if unspecified, for
example, "projects/api-test-project".
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.
require_open_jobs (bool): Optional.
Set to true if the companies requested must have open jobs.
Defaults to false.
If true, at most ``page_size`` of companies are fetched, among which
only those with open jobs are returned.
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.api_core.page_iterator.PageIterator` instance.
An iterable of :class:`~google.cloud.talent_v4beta1.types.Company` instances.
You can also iterate over the pages of the response
using its `pages` property.
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_companies" not in self._inner_api_calls:
self._inner_api_calls[
"list_companies"] = google.api_core.gapic_v1.method.wrap_method(
self.transport.list_companies,
default_retry=self._method_configs["ListCompanies"].retry,
default_timeout=self._method_configs["ListCompanies"].
timeout,
client_info=self._client_info,
)
request = company_service_pb2.ListCompaniesRequest(
parent=parent,
page_size=page_size,
require_open_jobs=require_open_jobs)
if metadata is None:
metadata = []
metadata = list(metadata)
try:
routing_header = [("parent", parent)]
except AttributeError:
pass
else:
routing_metadata = google.api_core.gapic_v1.routing_header.to_grpc_metadata(
routing_header)
metadata.append(routing_metadata)
iterator = google.api_core.page_iterator.GRPCIterator(
client=None,
method=functools.partial(
self._inner_api_calls["list_companies"],
retry=retry,
timeout=timeout,
metadata=metadata,
),
request=request,
items_field="companies",
request_token_field="page_token",
response_token_field="next_page_token",
)
return iterator