Class VersionsClient (0.3.0)

Version 0.3.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.

Properties

transport

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

Instantiate 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	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
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)

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_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 = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a xref_Version in the specified xref_Flow.

Parameters
Name	Description
request	.gcdc_version.CreateVersionRequest The request object. The request message for Versions.CreateVersion.
parent	str Required. The Flow to create an Version for. Format: projects/. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
version	.gcdc_version.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
.operation.Operation	An object representing a long-running operation. The result type for the operation will be .gcdc_version.Version : Represents a version of a flow.

delete_version

delete_version(request: Optional[google.cloud.dialogflowcx_v3beta1.types.version.DeleteVersionRequest] = 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_Version.

Parameters
Name	Description
request	.version.DeleteVersionRequest The request object. The request message for Versions.DeleteVersion.
name	str Required. The name of the Version 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.

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
{@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
Name	Description
filename	str The path to the service account private key json file.

Returns
Type	Description
{@api.name}	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 = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves the specified xref_Version.

Parameters
Name	Description
request	.version.GetVersionRequest The request object. The request message for Versions.GetVersion.
name	str Required. The name of the Version. 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
Type	Description
.version.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 = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the list of all versions in the specified xref_Flow.

Parameters
Name	Description
request	.version.ListVersionsRequest The request object. The request message for Versions.ListVersions.
parent	str Required. The Flow to list all versions 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
Type	Description
.pagers.ListVersionsPager	The response message for 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 = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Loads a specified version to draft version.

Parameters
Name	Description
request	.version.LoadVersionRequest The request object. The request message for Versions.LoadVersion.
name	str Required. The Version to be loaded to draft version. 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
Type	Description
.operation.Operation	An object representing a long-running operation. The result type for the operation will be .empty.Empty : A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: :: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

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)

Parse a version path into its component segments.

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 = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified xref_Version.

Parameters
Name	Description
request	.gcdc_version.UpdateVersionRequest The request object. The request message for Versions.UpdateVersion.
version	.gcdc_version.Version Required. The version to update. This corresponds to the version 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. Currently only description and display_name can be 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
.gcdc_version.Version	Represents a version of a flow.

version_path

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

Return a fully-qualified version string.