def test_list_intents(self): # Setup Expected Response next_page_token = '' intents_element = {} intents = [intents_element] expected_response = { 'next_page_token': next_page_token, 'intents': intents } expected_response = intent_pb2.ListIntentsResponse(**expected_response) # Mock the API response channel = ChannelStub(responses=[expected_response]) client = dialogflow_v2beta1.IntentsClient(channel=channel) # Setup Request parent = client.project_agent_path('[PROJECT]') paged_list_response = client.list_intents(parent) resources = list(paged_list_response) assert len(resources) == 1 assert expected_response.intents[0] == resources[0] assert len(channel.requests) == 1 expected_request = intent_pb2.ListIntentsRequest(parent=parent) actual_request = channel.requests[0][1] assert expected_request == actual_request
def test_list_intents(self): # Setup Expected Response next_page_token = "" intents_element = {} intents = [intents_element] expected_response = { "next_page_token": next_page_token, "intents": intents } expected_response = intent_pb2.ListIntentsResponse(**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 = dialogflow_v2beta1.IntentsClient() # Setup Request parent = client.project_agent_path("[PROJECT]") paged_list_response = client.list_intents(parent) resources = list(paged_list_response) assert len(resources) == 1 assert expected_response.intents[0] == resources[0] assert len(channel.requests) == 1 expected_request = intent_pb2.ListIntentsRequest(parent=parent) actual_request = channel.requests[0][1] assert expected_request == actual_request
def list_intents(self, parent, language_code=None, intent_view=None, page_size=None, retry=google.api_core.gapic_v1.method.DEFAULT, timeout=google.api_core.gapic_v1.method.DEFAULT): """ Returns the list of all intents in the specified agent. Example: >>> import dialogflow_v2beta1 >>> >>> client = dialogflow_v2beta1.IntentsClient() >>> >>> parent = client.project_agent_path('[PROJECT]') >>> >>> >>> # Iterate over all results >>> for element in client.list_intents(parent): ... # process element ... pass >>> >>> # Or iterate over results one page at a time >>> for page in client.list_intents(parent, options=CallOptions(page_token=INITIAL_PAGE)): ... for element in page: ... # process element ... pass Args: parent (str): Required. The agent to list all intents from. Format: ``projects/<Project ID>/agent``. language_code (str): Optional. The language to list training phrases, parameters and rich messages for. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. intent_view (~dialogflow_v2beta1.types.IntentView): Optional. The resource view to apply to the returned intent. 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. Returns: A :class:`~google.gax.PageIterator` instance. By default, this is an iterable of :class:`~dialogflow_v2beta1.types.Intent` 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. """ request = intent_pb2.ListIntentsRequest( parent=parent, language_code=language_code, intent_view=intent_view, page_size=page_size) iterator = google.api_core.page_iterator.GRPCIterator( client=None, method=functools.partial( self._list_intents, retry=retry, timeout=timeout), request=request, items_field='intents', request_token_field='page_token', response_token_field='next_page_token') return iterator
def list_intents(self, parent, language_code=None, intent_view=None, page_size=None, retry=google.api_core.gapic_v1.method.DEFAULT, timeout=google.api_core.gapic_v1.method.DEFAULT, metadata=None): """ Returns the list of all intents in the specified agent. Example: >>> import dialogflow_v2beta1 >>> >>> client = dialogflow_v2beta1.IntentsClient() >>> >>> parent = client.project_agent_path('[PROJECT]') >>> >>> # Iterate over all results >>> for element in client.list_intents(parent): ... # process element ... pass >>> >>> >>> # Alternatively: >>> >>> # Iterate over results one page at a time >>> for page in client.list_intents(parent).pages: ... for element in page: ... # process element ... pass Args: parent (str): Required. The agent to list all intents from. Format: ``projects/<Project ID>/agent``. language_code (str): Optional. The language to list training phrases, parameters and rich messages for. If not specified, the agent's default language is used. `Many languages <https://cloud.google.com/dialogflow-enterprise/docs/reference/language>`__ are supported. Note: languages must be enabled in the agent before they can be used. intent_view (~google.cloud.dialogflow_v2beta1.types.IntentView): Optional. The resource view to apply to the returned intent. 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.dialogflow_v2beta1.types.Intent` 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_intents' not in self._inner_api_calls: self._inner_api_calls[ 'list_intents'] = google.api_core.gapic_v1.method.wrap_method( self.transport.list_intents, default_retry=self._method_configs['ListIntents'].retry, default_timeout=self._method_configs['ListIntents']. timeout, client_info=self._client_info, ) request = intent_pb2.ListIntentsRequest( parent=parent, language_code=language_code, intent_view=intent_view, page_size=page_size, ) 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_intents'], retry=retry, timeout=timeout, metadata=metadata), request=request, items_field='intents', request_token_field='page_token', response_token_field='next_page_token', ) return iterator