Class VersionsClient (2.9.1)

VersionsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflow_v2.services.versions.transports.base.VersionsTransport]] = 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 Versions.

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
`VersionsTransport`	The transport used by the client instance.

Methods

VersionsClient

VersionsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflow_v2.services.versions.transports.base.VersionsTransport]] = 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>)

Instantiates the versions client.

Parameters
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, VersionsTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`google.api_core.client_options.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
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_version

create_version(request: Optional[Union[google.cloud.dialogflow_v2.types.version.CreateVersionRequest, dict]] = None, *, parent: Optional[str] = None, version: Optional[google.cloud.dialogflow_v2.types.version.Version] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates an agent version. The new version points to the agent instance in the "default" environment.

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflow_v2.types.CreateVersionRequest, dict]` The request object. The request message for Versions.CreateVersion.
`parent`	`str` Required. The agent to create a version for. Supported formats: - `projects/` - `projects/` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`version`	`google.cloud.dialogflow_v2.types.Version` Required. The version to create. This corresponds to the `version` 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

Type Description

google.cloud.dialogflow_v2.types.Version 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_version

delete_version(request: Optional[Union[google.cloud.dialogflow_v2.types.version.DeleteVersionRequest, dict]] = 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]] = ())

Delete the specified agent version.

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflow_v2.types.DeleteVersionRequest, dict]` The request object. The request message for Versions.DeleteVersion.
`name`	`str` Required. The name of the version to delete. Supported formats: - `projects/` - `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.

from_service_account_file

from_service_account_file(filename: str, *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
`VersionsClient`	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.

Parameter
Name	Description
`info`	`dict` The service account private key info.

Returns
Type	Description
`VersionsClient`	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
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`VersionsClient`	The constructed client.

get_version

get_version(request: Optional[Union[google.cloud.dialogflow_v2.types.version.GetVersionRequest, dict]] = 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 agent version.

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflow_v2.types.GetVersionRequest, dict]` The request object. The request message for Versions.GetVersion.
`name`	`str` Required. The name of the version. Supported formats: - `projects/` - `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

Type Description

list_versions

list_versions(request: Optional[Union[google.cloud.dialogflow_v2.types.version.ListVersionsRequest, dict]] = 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 versions of the specified agent.

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflow_v2.types.ListVersionsRequest, dict]` The request object. The request message for Versions.ListVersions.
`parent`	`str` Required. The agent to list all versions from. Supported formats: - `projects/` - `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
Type	Description
`google.cloud.dialogflow_v2.services.versions.pagers.ListVersionsPager`	The response message for Versions.ListVersions. 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_version_path

parse_version_path(path: str)

Parses a version path into its component segments.

update_version

update_version(request: Optional[Union[google.cloud.dialogflow_v2.types.version.UpdateVersionRequest, dict]] = None, *, version: Optional[google.cloud.dialogflow_v2.types.version.Version] = 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 agent version. Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflow_v2.types.UpdateVersionRequest, dict]` The request object. The request message for Versions.UpdateVersion.
`version`	`google.cloud.dialogflow_v2.types.Version` Required. The version to update. Supported formats: - `projects/` - `projects/` This corresponds to the `version` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.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

Type Description

version_path

version_path(project: str, version: str)

Returns a fully-qualified version string.