EnvironmentsAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dialogflow_v2beta1.services.environments.transports.base.EnvironmentsTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Service for managing Environments.
Inheritance
builtins.object > EnvironmentsAsyncClientProperties
transport
Returns the transport used by the client instance.
Type | Description |
EnvironmentsTransport | The transport used by the client instance. |
Methods
EnvironmentsAsyncClient
EnvironmentsAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dialogflow_v2beta1.services.environments.transports.base.EnvironmentsTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the environments client.
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, `.EnvironmentsTransport`]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
create_environment
create_environment(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.environment.CreateEnvironmentRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates an agent environment.
from google.cloud import dialogflow_v2beta1
async def sample_create_environment():
# Create a client
client = dialogflow_v2beta1.EnvironmentsAsyncClient()
# Initialize request argument(s)
request = dialogflow_v2beta1.CreateEnvironmentRequest(
parent="parent_value",
environment_id="environment_id_value",
)
# Make the request
response = await client.create_environment(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.dialogflow_v2beta1.types.CreateEnvironmentRequest, dict]
The request object. The request message for Environments.CreateEnvironment. |
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. |
Type | Description |
google.cloud.dialogflow_v2beta1.types.Environment | You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](\ https://cloud.google.com/dialogflow/docs/agents-versions). |
delete_environment
delete_environment(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.environment.DeleteEnvironmentRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes the specified agent environment.
from google.cloud import dialogflow_v2beta1
async def sample_delete_environment():
# Create a client
client = dialogflow_v2beta1.EnvironmentsAsyncClient()
# Initialize request argument(s)
request = dialogflow_v2beta1.DeleteEnvironmentRequest(
name="name_value",
)
# Make the request
await client.delete_environment(request=request)
Name | Description |
request |
Union[google.cloud.dialogflow_v2beta1.types.DeleteEnvironmentRequest, dict]
The request object. The request message for Environments.DeleteEnvironment. |
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. |
environment_path
environment_path(project: str, environment: str)
Returns a fully-qualified environment string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
EnvironmentsAsyncClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
EnvironmentsAsyncClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
EnvironmentsAsyncClient | The constructed client. |
fulfillment_path
fulfillment_path(project: str)
Returns a fully-qualified fulfillment string.
get_environment
get_environment(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.environment.GetEnvironmentRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves the specified agent environment.
from google.cloud import dialogflow_v2beta1
async def sample_get_environment():
# Create a client
client = dialogflow_v2beta1.EnvironmentsAsyncClient()
# Initialize request argument(s)
request = dialogflow_v2beta1.GetEnvironmentRequest(
name="name_value",
)
# Make the request
response = await client.get_environment(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.dialogflow_v2beta1.types.GetEnvironmentRequest, dict]
The request object. The request message for Environments.GetEnvironment. |
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. |
Type | Description |
google.cloud.dialogflow_v2beta1.types.Environment | You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](\ https://cloud.google.com/dialogflow/docs/agents-versions). |
get_environment_history
get_environment_history(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.environment.GetEnvironmentHistoryRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets the history of the specified environment.
from google.cloud import dialogflow_v2beta1
async def sample_get_environment_history():
# Create a client
client = dialogflow_v2beta1.EnvironmentsAsyncClient()
# Initialize request argument(s)
request = dialogflow_v2beta1.GetEnvironmentHistoryRequest(
parent="parent_value",
)
# Make the request
page_result = client.get_environment_history(request=request)
# Handle the response
async for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.dialogflow_v2beta1.types.GetEnvironmentHistoryRequest, dict]
The request object. The request message for Environments.GetEnvironmentHistory. |
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. |
Type | Description |
google.cloud.dialogflow_v2beta1.services.environments.pagers.GetEnvironmentHistoryAsyncPager | The response message for Environments.GetEnvironmentHistory. Iterating over this object will yield results and resolve additional pages automatically. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
list_environments
list_environments(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.environment.ListEnvironmentsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns the list of all non-draft environments of the specified agent.
from google.cloud import dialogflow_v2beta1
async def sample_list_environments():
# Create a client
client = dialogflow_v2beta1.EnvironmentsAsyncClient()
# Initialize request argument(s)
request = dialogflow_v2beta1.ListEnvironmentsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_environments(request=request)
# Handle the response
async for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.dialogflow_v2beta1.types.ListEnvironmentsRequest, dict]
The request object. The request message for Environments.ListEnvironments. |
parent |
`str`
Required. The agent to list all environments from. Format: - |
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. |
Type | Description |
google.cloud.dialogflow_v2beta1.services.environments.pagers.ListEnvironmentsAsyncPager | The response message for Environments.ListEnvironments. Iterating over this object will yield results and resolve additional pages automatically. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_environment_path
parse_environment_path(path: str)
Parses a environment path into its component segments.
parse_fulfillment_path
parse_fulfillment_path(path: str)
Parses a fulfillment path into its component segments.
parse_version_path
parse_version_path(path: str)
Parses a version path into its component segments.
update_environment
update_environment(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.environment.UpdateEnvironmentRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates the specified agent environment.
This method allows you to deploy new agent versions into the
environment. When an environment is pointed to a new agent
version by setting environment.agent_version
, the
environment is temporarily set to the LOADING
state. During
that time, the environment keeps on serving the previous version
of the agent. After the new agent version is done loading, the
environment is set back to the RUNNING
state. You can use
"-" as Environment ID in environment name to update version in
"draft" environment. WARNING: this will negate all recent
changes to draft and can't be undone. You may want to save the
draft to a version before calling this function.
from google.cloud import dialogflow_v2beta1
async def sample_update_environment():
# Create a client
client = dialogflow_v2beta1.EnvironmentsAsyncClient()
# Initialize request argument(s)
request = dialogflow_v2beta1.UpdateEnvironmentRequest(
)
# Make the request
response = await client.update_environment(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.dialogflow_v2beta1.types.UpdateEnvironmentRequest, dict]
The request object. The request message for Environments.UpdateEnvironment. |
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. |
Type | Description |
google.cloud.dialogflow_v2beta1.types.Environment | You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](\ https://cloud.google.com/dialogflow/docs/agents-versions). |
version_path
version_path(project: str, version: str)
Returns a fully-qualified version string.