Class ExperimentsAsyncClient (1.29.0)

ExperimentsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.dialogflowcx_v3.services.experiments.transports.base.ExperimentsTransport] = 'grpc_asyncio', client_options: typing.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 Experiments.

Properties

transport

Returns the transport used by the client instance.

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

Methods

ExperimentsAsyncClient

ExperimentsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.dialogflowcx_v3.services.experiments.transports.base.ExperimentsTransport] = 'grpc_asyncio', client_options: typing.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 experiments 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, .ExperimentsTransport]` The transport to use. If set to None, a transport is chosen automatically.
`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.

Exceptions
Type	Description
`google.auth.exceptions.MutualTlsChannelError`	If mutual TLS transport creation failed for any reason.

cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

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.

Parameters
Name	Description
`request`	`.operations_pb2.CancelOperationRequest` The request object. Request message for `CancelOperation` method.
`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.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_experiment

create_experiment(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflowcx_v3.types.experiment.CreateExperimentRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    experiment: typing.Optional[
        google.cloud.dialogflowcx_v3.types.experiment.Experiment
    ] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dialogflowcx_v3.types.experiment.Experiment

Creates an xref_Experiment in the specified xref_Environment.

# 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_v3

async def sample_create_experiment():
    # Create a client
    client = dialogflowcx_v3.ExperimentsAsyncClient()

    # Initialize request argument(s)
    experiment = dialogflowcx_v3.Experiment()
    experiment.display_name = "display_name_value"

    request = dialogflowcx_v3.CreateExperimentRequest(
        parent="parent_value",
        experiment=experiment,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.dialogflowcx_v3.types.CreateExperimentRequest, dict]]` The request object. The request message for Experiments.CreateExperiment.
`parent`	`str` Required. The Agent to create an Environment for. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`experiment`	`Experiment` Required. The experiment to create. This corresponds to the `experiment` 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.dialogflowcx_v3.types.Experiment`	Represents an experiment in an environment.

delete_experiment

delete_experiment(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflowcx_v3.types.experiment.DeleteExperimentRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes the specified xref_Experiment.

# 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_v3

async def sample_delete_experiment():
    # Create a client
    client = dialogflowcx_v3.ExperimentsAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.DeleteExperimentRequest(
        name="name_value",
    )

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

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.dialogflowcx_v3.types.DeleteExperimentRequest, dict]]` The request object. The request message for Experiments.DeleteExperiment.
`name`	`str` Required. The name of the Environment 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.

experiment_path

experiment_path(
    project: str, location: str, agent: str, environment: str, experiment: str
) -> str

Returns a fully-qualified experiment string.

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
`ExperimentsAsyncClient`	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
`ExperimentsAsyncClient`	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
`ExperimentsAsyncClient`	The constructed client.

get_experiment

get_experiment(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflowcx_v3.types.experiment.GetExperimentRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dialogflowcx_v3.types.experiment.Experiment

Retrieves the specified xref_Experiment.

# 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_v3

async def sample_get_experiment():
    # Create a client
    client = dialogflowcx_v3.ExperimentsAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.GetExperimentRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.dialogflowcx_v3.types.GetExperimentRequest, dict]]` The request object. The request message for Experiments.GetExperiment.
`name`	`str` Required. The name of the Environment. 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
`google.cloud.dialogflowcx_v3.types.Experiment`	Represents an experiment in an environment.

get_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = None,
    *,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

Parameters
Name	Description
`request`	`.location_pb2.GetLocationRequest` The request object. Request message for `GetLocation` method.
`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
`.location_pb2.Location`	Location object.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.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 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.

Parameter
Name	Description
`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
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If any errors happen.

Returns
Type	Description
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	returns the API endpoint and the client cert source to use.

get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name	Description
`request`	`.operations_pb2.GetOperationRequest` The request object. Request message for `GetOperation` method.
`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
`.operations_pb2.Operation`	An `Operation` object.

get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.dialogflowcx_v3.services.experiments.transports.base.ExperimentsTransport
    ]
)

Returns an appropriate transport class.

Parameter
Name	Description
`label`	`typing.Optional[str]` The name of the desired transport. If none is provided, then the first transport in the registry is used.

list_experiments

list_experiments(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflowcx_v3.types.experiment.ListExperimentsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dialogflowcx_v3.services.experiments.pagers.ListExperimentsAsyncPager

Returns the list of all experiments in the specified xref_Environment.

# 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_v3

async def sample_list_experiments():
    # Create a client
    client = dialogflowcx_v3.ExperimentsAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.ListExperimentsRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.dialogflowcx_v3.types.ListExperimentsRequest, dict]]` The request object. The request message for Experiments.ListExperiments.
`parent`	`str` Required. The Environment to list all environments 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
`google.cloud.dialogflowcx_v3.services.experiments.pagers.ListExperimentsAsyncPager`	The response message for Experiments.ListExperiments. Iterating over this object will yield results and resolve additional pages automatically.

list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = None,
    *,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

Parameters
Name	Description
`request`	`.location_pb2.ListLocationsRequest` The request object. Request message for `ListLocations` method.
`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
`.location_pb2.ListLocationsResponse`	Response message for `ListLocations` method.

list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name	Description
`request`	`.operations_pb2.ListOperationsRequest` The request object. Request message for `ListOperations` method.
`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
`.operations_pb2.ListOperationsResponse`	Response message for `ListOperations` method.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_experiment_path

parse_experiment_path(path: str) -> typing.Dict[str, str]

Parses a experiment path into its component segments.

parse_version_path

parse_version_path(path: str) -> typing.Dict[str, str]

Parses a version path into its component segments.

start_experiment

start_experiment(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflowcx_v3.types.experiment.StartExperimentRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dialogflowcx_v3.types.experiment.Experiment

Starts the specified xref_Experiment. This rpc only changes the state of experiment from PENDING to RUNNING.

# 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_v3

async def sample_start_experiment():
    # Create a client
    client = dialogflowcx_v3.ExperimentsAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.StartExperimentRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.dialogflowcx_v3.types.StartExperimentRequest, dict]]` The request object. The request message for Experiments.StartExperiment.
`name`	`str` Required. Resource name of the experiment to start. 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
`google.cloud.dialogflowcx_v3.types.Experiment`	Represents an experiment in an environment.

stop_experiment

stop_experiment(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflowcx_v3.types.experiment.StopExperimentRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dialogflowcx_v3.types.experiment.Experiment

Stops the specified xref_Experiment. This rpc only changes the state of experiment from RUNNING to DONE.

# 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_v3

async def sample_stop_experiment():
    # Create a client
    client = dialogflowcx_v3.ExperimentsAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.StopExperimentRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.dialogflowcx_v3.types.StopExperimentRequest, dict]]` The request object. The request message for Experiments.StopExperiment.
`name`	`str` Required. Resource name of the experiment to stop. 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
`google.cloud.dialogflowcx_v3.types.Experiment`	Represents an experiment in an environment.

update_experiment

update_experiment(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflowcx_v3.types.experiment.UpdateExperimentRequest, dict
        ]
    ] = None,
    *,
    experiment: typing.Optional[
        google.cloud.dialogflowcx_v3.types.experiment.Experiment
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dialogflowcx_v3.types.experiment.Experiment

Updates the specified xref_Experiment.

# 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_v3

async def sample_update_experiment():
    # Create a client
    client = dialogflowcx_v3.ExperimentsAsyncClient()

    # Initialize request argument(s)
    experiment = dialogflowcx_v3.Experiment()
    experiment.display_name = "display_name_value"

    request = dialogflowcx_v3.UpdateExperimentRequest(
        experiment=experiment,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.dialogflowcx_v3.types.UpdateExperimentRequest, dict]]` The request object. The request message for Experiments.UpdateExperiment.
`experiment`	`Experiment` Required. The experiment to update. This corresponds to the `experiment` 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
`google.cloud.dialogflowcx_v3.types.Experiment`	Represents an experiment in an environment.

version_path

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

Returns a fully-qualified version string.