Class VersionsClient (1.11.0)

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

Returns the transport used by the client instance.

Returns
TypeDescription
VersionsTransportThe 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>)

Instantiates the versions 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, 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
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

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.

compare_versions

compare_versions(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.version.CompareVersionsRequest, dict]] = None, *, base_version: 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]] = ())

Compares the specified base version with target version.

from google.cloud import dialogflowcx_v3beta1

def sample_compare_versions():
    # Create a client
    client = dialogflowcx_v3beta1.VersionsClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.CompareVersionsRequest(
        base_version="base_version_value",
        target_version="target_version_value",
    )

    # Make the request
    response = client.compare_versions(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.dialogflowcx_v3beta1.types.CompareVersionsRequest, dict]

The request object. The request message for Versions.CompareVersions.

base_version str

Required. Name of the base flow version to compare with the target version. Use version ID 0 to indicate the draft version of the specified flow. Format: projects/. This corresponds to the base_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
TypeDescription
google.cloud.dialogflowcx_v3beta1.types.CompareVersionsResponseThe response message for Versions.CompareVersions.

create_version

create_version(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.version.CreateVersionRequest, dict]] = None, *, parent: Optional[str] = None, version: Optional[google.cloud.dialogflowcx_v3beta1.types.version.Version] = 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 a xref_Version in the specified xref_Flow.

This method is a long-running operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>__. The returned Operation type has the following method-specific fields:

  • metadata: xref_CreateVersionOperationMetadata
  • response: xref_Version
from google.cloud import dialogflowcx_v3beta1

def sample_create_version():
    # Create a client
    client = dialogflowcx_v3beta1.VersionsClient()

    # Initialize request argument(s)
    version = dialogflowcx_v3beta1.Version()
    version.display_name = "display_name_value"

    request = dialogflowcx_v3beta1.CreateVersionRequest(
        parent="parent_value",
        version=version,
    )

    # Make the request
    operation = client.create_version(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.dialogflowcx_v3beta1.types.CreateVersionRequest, dict]

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 google.cloud.dialogflowcx_v3beta1.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
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be Version Represents a version of a flow.

delete_version

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

Deletes the specified xref_Version.

from google.cloud import dialogflowcx_v3beta1

def sample_delete_version():
    # Create a client
    client = dialogflowcx_v3beta1.VersionsClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.DeleteVersionRequest(
        name="name_value",
    )

    # Make the request
    client.delete_version(request=request)
Parameters
NameDescription
request Union[google.cloud.dialogflowcx_v3beta1.types.DeleteVersionRequest, dict]

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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
VersionsClientThe 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
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
VersionsClientThe 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
VersionsClientThe constructed client.

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.

Parameter
NameDescription
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf any errors happen.
Returns
TypeDescription
Tuple[str, Callable[[], Tuple[bytes, bytes]]]returns the API endpoint and the client cert source to use.

get_version

get_version(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.version.GetVersionRequest, dict]] = None, *, name: 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]] = ())

Retrieves the specified xref_Version.

from google.cloud import dialogflowcx_v3beta1

def sample_get_version():
    # Create a client
    client = dialogflowcx_v3beta1.VersionsClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.GetVersionRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_version(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.dialogflowcx_v3beta1.types.GetVersionRequest, dict]

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
TypeDescription
google.cloud.dialogflowcx_v3beta1.types.VersionRepresents a version of a flow.

list_versions

list_versions(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.version.ListVersionsRequest, 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 versions in the specified xref_Flow.

from google.cloud import dialogflowcx_v3beta1

def sample_list_versions():
    # Create a client
    client = dialogflowcx_v3beta1.VersionsClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.ListVersionsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_versions(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
NameDescription
request Union[google.cloud.dialogflowcx_v3beta1.types.ListVersionsRequest, dict]

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
TypeDescription
google.cloud.dialogflowcx_v3beta1.services.versions.pagers.ListVersionsPagerThe response message for Versions.ListVersions. Iterating over this object will yield results and resolve additional pages automatically.

load_version

load_version(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.version.LoadVersionRequest, dict]] = None, *, name: 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]] = ())

Loads resources in the specified version to the draft flow.

This method is a long-running operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>__. The returned Operation type has the following method-specific fields:

  • metadata: An empty Struct message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct>__
  • response: An Empty message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty>__
from google.cloud import dialogflowcx_v3beta1

def sample_load_version():
    # Create a client
    client = dialogflowcx_v3beta1.VersionsClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.LoadVersionRequest(
        name="name_value",
    )

    # Make the request
    operation = client.load_version(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.dialogflowcx_v3beta1.types.LoadVersionRequest, dict]

The request object. The request message for Versions.LoadVersion.

name str

Required. The Version to be loaded to draft flow. 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
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.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)

Parses a version path into its component segments.

update_version

update_version(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.version.UpdateVersionRequest, dict]] = None, *, version: Optional[google.cloud.dialogflowcx_v3beta1.types.version.Version] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = 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 xref_Version.

from google.cloud import dialogflowcx_v3beta1

def sample_update_version():
    # Create a client
    client = dialogflowcx_v3beta1.VersionsClient()

    # Initialize request argument(s)
    version = dialogflowcx_v3beta1.Version()
    version.display_name = "display_name_value"

    request = dialogflowcx_v3beta1.UpdateVersionRequest(
        version=version,
    )

    # Make the request
    response = client.update_version(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.dialogflowcx_v3beta1.types.UpdateVersionRequest, dict]

The request object. The request message for Versions.UpdateVersion.

version google.cloud.dialogflowcx_v3beta1.types.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 google.protobuf.field_mask_pb2.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
TypeDescription
google.cloud.dialogflowcx_v3beta1.types.VersionRepresents 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.