Class EnvironmentsClient (0.2.0)

EnvironmentsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3beta1.services.environments.transports.base.EnvironmentsTransport]] = None, 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.

Properties

transport

Return the transport used by the client instance.

Returns
TypeDescription
EnvironmentsTransportThe transport used by the client instance.

Methods

EnvironmentsClient

EnvironmentsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3beta1.services.environments.transports.base.EnvironmentsTransport]] = None, 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>)

Instantiate the environments client.

Parameters
NameDescription
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 client_options_lib.ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be 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.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf mutual TLS transport creation failed for any reason.

common_billing_account_path

common_billing_account_path(billing_account: str)

Return a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Return a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Return a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Return a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Return a fully-qualified project string.

create_environment

create_environment(request: Optional[google.cloud.dialogflowcx_v3beta1.types.environment.CreateEnvironmentRequest] = None, *, parent: Optional[str] = None, environment: Optional[google.cloud.dialogflowcx_v3beta1.types.environment.Environment] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates an xref_Environment in the specified xref_Agent.

Parameters
NameDescription
request .gcdc_environment.CreateEnvironmentRequest

The request object. The request message for Environments.CreateEnvironment.

parent str

Required. The Agent to create an Environment for. Format: projects/. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

environment .gcdc_environment.Environment

Required. The environment to create. This corresponds to the environment field on the request instance; if request is provided, this should not be set.

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.

Returns
TypeDescription
.operation.OperationAn object representing a long-running operation. The result type for the operation will be
.gcdc_environment.Environment
: Represents an environment for an agent. 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.

delete_environment

delete_environment(request: Optional[google.cloud.dialogflowcx_v3beta1.types.environment.DeleteEnvironmentRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified xref_Environment.

Parameters
NameDescription
request .environment.DeleteEnvironmentRequest

The request object. The request message for Environments.DeleteEnvironment.

name str

Required. The name of the Environment to delete. Format: projects/. This corresponds to the name field on the request instance; if request is provided, this should not be set.

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, location: str, agent: str, environment: str)

Return 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.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
{@api.name}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.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
{@api.name}The constructed client.

get_environment

get_environment(request: Optional[google.cloud.dialogflowcx_v3beta1.types.environment.GetEnvironmentRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves the specified xref_Environment.

Parameters
NameDescription
request .environment.GetEnvironmentRequest

The request object. The request message for Environments.GetEnvironment.

name str

Required. The name of the Environment. Format: projects/. This corresponds to the name field on the request instance; if request is provided, this should not be set.

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.

Returns
TypeDescription
.environment.EnvironmentRepresents an environment for an agent. 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.

list_environments

list_environments(request: Optional[google.cloud.dialogflowcx_v3beta1.types.environment.ListEnvironmentsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the list of all environments in the specified xref_Agent.

Parameters
NameDescription
request .environment.ListEnvironmentsRequest

The request object. The request message for Environments.ListEnvironments.

parent str

Required. The Agent to list all environments for. Format: projects/. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

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.

Returns
TypeDescription
.pagers.ListEnvironmentsPagerThe response message for Environments.ListEnvironments. Iterating over this object will yield results and resolve additional pages automatically.

lookup_environment_history

lookup_environment_history(request: Optional[google.cloud.dialogflowcx_v3beta1.types.environment.LookupEnvironmentHistoryRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Looks up the history of the specified xref_Environment.

Parameters
NameDescription
request .environment.LookupEnvironmentHistoryRequest

The request object. The request message for Environments.LookupEnvironmentHistory.

name str

Required. Resource name of the environment to look up the history for. Format: projects/. This corresponds to the name field on the request instance; if request is provided, this should not be set.

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.

Returns
TypeDescription
.pagers.LookupEnvironmentHistoryPagerThe response message for Environments.LookupEnvironmentHistory. 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)

Parse a environment path into its component segments.

parse_version_path

parse_version_path(path: str)

Parse a version path into its component segments.

update_environment

update_environment(request: Optional[google.cloud.dialogflowcx_v3beta1.types.environment.UpdateEnvironmentRequest] = None, *, environment: Optional[google.cloud.dialogflowcx_v3beta1.types.environment.Environment] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified xref_Environment.

Parameters
NameDescription
request .gcdc_environment.UpdateEnvironmentRequest

The request object. The request message for Environments.UpdateEnvironment.

environment .gcdc_environment.Environment

Required. The environment to update. This corresponds to the environment field on the request instance; if request is provided, this should not be set.

update_mask .field_mask.FieldMask

Required. The mask to control which fields get updated. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

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.

Returns
TypeDescription
.operation.OperationAn object representing a long-running operation. The result type for the operation will be
.gcdc_environment.Environment
: Represents an environment for an agent. 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.

version_path

version_path(project: str, location: str, agent: str, flow: str, version: str)

Return a fully-qualified version string.