Class VersionsClient (0.8.0)

Version 0.8.0

• 1.37.0 (latest)
• 1.36.0
• 1.35.0
• 1.34.1
• 1.33.0
• 1.32.1
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.1
• 1.22.0
• 1.21.0
• 1.20.1
• 1.19.0
• 1.18.0
• 1.17.1
• 1.16.0
• 1.15.0
• 1.14.1
• 1.13.5
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.1
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.1
• 1.0.0
• 0.8.2
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.0
• 0.2.0
• 0.1.1

VersionsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3beta1.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][google.cloud.dialogflow.cx.v3beta1.Version].

Inheritance

builtins.object > VersionsClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
VersionsTransport	The transport used by the client instance.

Methods

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

Parameter

Name	Description
billing_account

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

Parameter

Name	Description
folder

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

Parameters

Name	Description
project
location

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

Parameter

Name	Description
organization

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

Parameter

Name	Description
project

create_version

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

Creates a [Version][google.cloud.dialogflow.cx.v3beta1.Version] in the specified [Flow][google.cloud.dialogflow.cx.v3beta1.Flow].

Parameter

Name	Description
request	google.cloud.dialogflowcx_v3beta1.types.CreateVersionRequest The request object. The request message for [Versions.CreateVersion][google.cloud.dialogflow.cx.v3beta1.Versions.CreateVersion].

Returns

Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be

delete_version

delete_version(request: Optional[google.cloud.dialogflowcx_v3beta1.types.version.DeleteVersionRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified [Version][google.cloud.dialogflow.cx.v3beta1.Version].

Parameter

Name	Description
request	google.cloud.dialogflowcx_v3beta1.types.DeleteVersionRequest The request object. The request message for [Versions.DeleteVersion][google.cloud.dialogflow.cx.v3beta1.Versions.DeleteVersion].

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

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

Parameters

Name	Description
filename	str The path to the service account private key json file.
args	Additional arguments to pass to the constructor.
kwargs	Additional arguments to pass to the constructor.

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.

Parameters

Name	Description
info	dict The service account private key info.
args	Additional arguments to pass to the constructor.
kwargs	Additional arguments to pass to the constructor.

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.

Parameters

Name	Description
filename	str The path to the service account private key json file.
args	Additional arguments to pass to the constructor.
kwargs	Additional arguments to pass to the constructor.

Returns

Type	Description
VersionsClient	The constructed client.

get_version

get_version(request: Optional[google.cloud.dialogflowcx_v3beta1.types.version.GetVersionRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves the specified [Version][google.cloud.dialogflow.cx.v3beta1.Version].

Parameter

Name	Description
request	google.cloud.dialogflowcx_v3beta1.types.GetVersionRequest The request object. The request message for [Versions.GetVersion][google.cloud.dialogflow.cx.v3beta1.Versions.GetVersion].

Returns

Type	Description
google.cloud.dialogflowcx_v3beta1.types.Version	Represents a version of a flow.

list_versions

list_versions(request: Optional[google.cloud.dialogflowcx_v3beta1.types.version.ListVersionsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the list of all versions in the specified [Flow][google.cloud.dialogflow.cx.v3beta1.Flow].

Parameter

Name	Description
request	google.cloud.dialogflowcx_v3beta1.types.ListVersionsRequest The request object. The request message for [Versions.ListVersions][google.cloud.dialogflow.cx.v3beta1.Versions.ListVersions].

Returns

Type	Description
google.cloud.dialogflowcx_v3beta1.services.versions.pagers.ListVersionsPager	The response message for [Versions.ListVersions][google.cloud.dialogflow.cx.v3beta1.Versions.ListVersions]. Iterating over this object will yield results and resolve additional pages automatically.

load_version

load_version(request: Optional[google.cloud.dialogflowcx_v3beta1.types.version.LoadVersionRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Loads resources in the specified version to the draft flow.

Parameter

Name	Description
request	google.cloud.dialogflowcx_v3beta1.types.LoadVersionRequest The request object. The request message for [Versions.LoadVersion][google.cloud.dialogflow.cx.v3beta1.Versions.LoadVersion].

Returns

Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

Parameter

Name	Description
path

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

Parameter

Name	Description
path

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

Parameter

Name	Description
path

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

Parameter

Name	Description
path

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

Parameter

Name	Description
path

parse_version_path

parse_version_path(path: str)

Parses a version path into its component segments.

Parameter

Name	Description
path

update_version

update_version(request: Optional[google.cloud.dialogflowcx_v3beta1.types.version.UpdateVersionRequest] = None, *, version: Optional[google.cloud.dialogflowcx_v3beta1.types.version.Version] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified [Version][google.cloud.dialogflow.cx.v3beta1.Version].

Parameter

Name	Description
request	google.cloud.dialogflowcx_v3beta1.types.UpdateVersionRequest The request object. The request message for [Versions.UpdateVersion][google.cloud.dialogflow.cx.v3beta1.Versions.UpdateVersion].

Returns

Type	Description
google.cloud.dialogflowcx_v3beta1.types.Version	Represents a version of a flow.

version_path

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

Returns a fully-qualified version string.

Parameters

Name	Description
project
location
agent
flow
version