Class EnvironmentsClient (1.1.3)

  EnvironmentsClient 
 ( 
 transport 
 = 
 None 
 , 
 channel 
 = 
 None 
 , 
 credentials 
 = 
 None 
 , 
 client_config 
 = 
 None 
 , 
 client_info 
 = 
 None 
 , 
 client_options 
 = 
 None 
 , 
 ) 
 

Service for managing Environments .

Methods

EnvironmentsClient

  EnvironmentsClient 
 ( 
 transport 
 = 
 None 
 , 
 channel 
 = 
 None 
 , 
 credentials 
 = 
 None 
 , 
 client_config 
 = 
 None 
 , 
 client_info 
 = 
 None 
 , 
 client_options 
 = 
 None 
 , 
 ) 
 

Constructor.

Parameters
Name
Description
channel
grpc.Channel

DEPRECATED. A Channel instance through which to make calls. This argument is mutually exclusive with credentials ; providing both will raise an exception.

credentials
google.auth.credentials.Credentials

The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to transport ; doing so will raise an exception.

client_config
dict

DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used.

client_info
google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None , then default info will be used. Generally, you only need to set this if you're developing your own client library.

client_options
Union[dict, google.api_core.client_options.ClientOptions]

Client options used to set user options on the client. API Endpoint should be set through client_options.

agent_path

  agent_path 
 ( 
 project 
 ) 
 

Return a fully-qualified agent string.

  from_service_account_file 
 ( 
 filename 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

Creates an instance of this client using the provided credentials file.

Parameter
Name
Description
filename
str

The path to the service account private key json file.

Returns
Type
Description
dialogflow_v2.EnvironmentsClient
The constructed client.
  from_service_account_json 
 ( 
 filename 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

Creates an instance of this client using the provided credentials file.

Parameter
Name
Description
filename
str

The path to the service account private key json file.

Returns
Type
Description
dialogflow_v2.EnvironmentsClient
The constructed client.

list_environments

  list_environments 
 ( 
 parent 
 , 
 page_size 
 = 
 None 
 , 
 retry 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 metadata 
 = 
 None 
 ) 
 

Returns the list of all non-draft environments of the specified agent.

.. rubric:: Example

import dialogflow_v2

client = dialogflow_v2.EnvironmentsClient()

parent = client.agent_path('[PROJECT]')

Iterate over all results

for element in client.list_environments(parent): ... # process element ... pass

Alternatively:

Iterate over results one page at a time

for page in client.list_environments(parent).pages: ... for element in page: ... # process element ... pass

Parameters
Name
Description
parent
str

Required. The agent to list all environments from. Format: projects/ .

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 be retried using a default configuration.

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.

Exceptions
Type
Description
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.
Create a Mobile Website
View Site in Mobile | Classic
Share by: