Class FlowsAsyncClient (1.37.0)

Service for managing Flows.

Return the API endpoint used by the client instance.

Returns the transport used by the client instance.

Return the universe domain used by the client instance.

Instantiates the flows async client.

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Returns a fully-qualified billing_account string.

Returns a fully-qualified folder string.

Returns a fully-qualified location string.

Returns a fully-qualified organization string.

Returns a fully-qualified project string.

Creates a flow in the specified agent.

Note: You should always train a flow prior to sending it queries. See the training documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>__.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

async def sample_create_flow():
    # Create a client
    client = dialogflowcx_v3beta1.FlowsAsyncClient()

    # Initialize request argument(s)
    flow = dialogflowcx_v3beta1.Flow()
    flow.display_name = "display_name_value"

    request = dialogflowcx_v3beta1.CreateFlowRequest(
        parent="parent_value",
        flow=flow,
    )

    # Make the request
    response = await client.create_flow(request=request)

    # Handle the response
    print(response)

Deletes a specified flow.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

async def sample_delete_flow():
    # Create a client
    client = dialogflowcx_v3beta1.FlowsAsyncClient()

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

    # Make the request
    await client.delete_flow(request=request)

Exports the specified flow to a binary file.

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: xref_ExportFlowResponse

Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

async def sample_export_flow():
    # Create a client
    client = dialogflowcx_v3beta1.FlowsAsyncClient()

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

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Returns a fully-qualified flow string.

Returns a fully-qualified flow_validation_result string.

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

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

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

Retrieves the specified flow.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

async def sample_get_flow():
    # Create a client
    client = dialogflowcx_v3beta1.FlowsAsyncClient()

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

    # Make the request
    response = await client.get_flow(request=request)

    # Handle the response
    print(response)

Gets the latest flow validation result. Flow validation is performed when ValidateFlow is called.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

async def sample_get_flow_validation_result():
    # Create a client
    client = dialogflowcx_v3beta1.FlowsAsyncClient()

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

    # Make the request
    response = await client.get_flow_validation_result(request=request)

    # Handle the response
    print(response)

Gets information about a location.

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

Gets the latest state of a long-running operation.

Returns an appropriate transport class.

Imports the specified flow to the specified agent from a binary file.

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: xref_ImportFlowResponse

Note: You should always train a flow prior to sending it queries. See the training documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>__.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

async def sample_import_flow():
    # Create a client
    client = dialogflowcx_v3beta1.FlowsAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.ImportFlowRequest(
        flow_uri="flow_uri_value",
        parent="parent_value",
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Returns a fully-qualified intent string.

Returns the list of all flows in the specified agent.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

async def sample_list_flows():
    # Create a client
    client = dialogflowcx_v3beta1.FlowsAsyncClient()

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

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

    # Handle the response
    async for response in page_result:
        print(response)

Lists information about the supported locations for this service.

Lists operations that match the specified filter in the request.

Returns a fully-qualified page string.

Parse a billing_account path into its component segments.

Parse a folder path into its component segments.

Parse a location path into its component segments.

Parse a organization path into its component segments.

Parse a project path into its component segments.

Parses a flow path into its component segments.

Parses a flow_validation_result path into its component segments.

Parses a intent path into its component segments.

Parses a page path into its component segments.

Parses a playbook path into its component segments.

Parses a tool path into its component segments.

Parses a transition_route_group path into its component segments.

Parses a webhook path into its component segments.

Returns a fully-qualified playbook string.

Returns a fully-qualified tool string.

Trains the specified flow. Note that only the flow in 'draft' environment is trained.

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>__

Note: You should always train a flow prior to sending it queries. See the training documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>__.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

async def sample_train_flow():
    # Create a client
    client = dialogflowcx_v3beta1.FlowsAsyncClient()

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

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Returns a fully-qualified transition_route_group string.

Updates the specified flow.

Note: You should always train a flow prior to sending it queries. See the training documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>__.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

async def sample_update_flow():
    # Create a client
    client = dialogflowcx_v3beta1.FlowsAsyncClient()

    # Initialize request argument(s)
    flow = dialogflowcx_v3beta1.Flow()
    flow.display_name = "display_name_value"

    request = dialogflowcx_v3beta1.UpdateFlowRequest(
        flow=flow,
    )

    # Make the request
    response = await client.update_flow(request=request)

    # Handle the response
    print(response)

Validates the specified flow and creates or updates validation results. Please call this API after the training is completed to get the complete validation results.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

async def sample_validate_flow():
    # Create a client
    client = dialogflowcx_v3beta1.FlowsAsyncClient()

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

    # Make the request
    response = await client.validate_flow(request=request)

    # Handle the response
    print(response)

Returns a fully-qualified webhook string.