Google Cloud Dialogflow Cx V3 Client - Class ExperimentsClient (0.5.1)

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\ExperimentsClient;
use Google\Cloud\Dialogflow\Cx\V3\CreateExperimentRequest;
use Google\Cloud\Dialogflow\Cx\V3\Experiment;

/**
 * @param string $formattedParent       The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an
 *                                      [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format:
 *                                      `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`. Please see
 *                                      {@see ExperimentsClient::environmentName()} for help formatting this field.
 * @param string $experimentDisplayName The human-readable name of the experiment (unique in an
 *                                      environment). Limit of 64 characters.
 */
function create_experiment_sample(string $formattedParent, string $experimentDisplayName): void
{
    // Create a client.
    $experimentsClient = new ExperimentsClient();

    // Prepare the request message.
    $experiment = (new Experiment())
        ->setDisplayName($experimentDisplayName);
    $request = (new CreateExperimentRequest())
        ->setParent($formattedParent)
        ->setExperiment($experiment);

    // Call the API and handle any network failures.
    try {
        /** @var Experiment $response */
        $response = $experimentsClient->createExperiment($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = ExperimentsClient::environmentName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[ENVIRONMENT]'
    );
    $experimentDisplayName = '[DISPLAY_NAME]';

    create_experiment_sample($formattedParent, $experimentDisplayName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\ExperimentsClient;
use Google\Cloud\Dialogflow\Cx\V3\DeleteExperimentRequest;

/**
 * @param string $formattedName The name of the
 *                              [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/experiments/<ExperimentID>`. Please see
 *                              {@see ExperimentsClient::experimentName()} for help formatting this field.
 */
function delete_experiment_sample(string $formattedName): void
{
    // Create a client.
    $experimentsClient = new ExperimentsClient();

    // Prepare the request message.
    $request = (new DeleteExperimentRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $experimentsClient->deleteExperiment($request);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ExperimentsClient::experimentName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[ENVIRONMENT]',
        '[EXPERIMENT]'
    );

    delete_experiment_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\ExperimentsClient;
use Google\Cloud\Dialogflow\Cx\V3\Experiment;
use Google\Cloud\Dialogflow\Cx\V3\GetExperimentRequest;

/**
 * @param string $formattedName The name of the
 *                              [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/experiments/<ExperimentID>`. Please see
 *                              {@see ExperimentsClient::experimentName()} for help formatting this field.
 */
function get_experiment_sample(string $formattedName): void
{
    // Create a client.
    $experimentsClient = new ExperimentsClient();

    // Prepare the request message.
    $request = (new GetExperimentRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Experiment $response */
        $response = $experimentsClient->getExperiment($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ExperimentsClient::experimentName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[ENVIRONMENT]',
        '[EXPERIMENT]'
    );

    get_experiment_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\Cx\V3\Client\ExperimentsClient;
use Google\Cloud\Dialogflow\Cx\V3\Experiment;
use Google\Cloud\Dialogflow\Cx\V3\ListExperimentsRequest;

/**
 * @param string $formattedParent The [Environment][google.cloud.dialogflow.cx.v3.Environment] to
 *                                list all environments for. Format:
 *                                `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`. Please see
 *                                {@see ExperimentsClient::environmentName()} for help formatting this field.
 */
function list_experiments_sample(string $formattedParent): void
{
    // Create a client.
    $experimentsClient = new ExperimentsClient();

    // Prepare the request message.
    $request = (new ListExperimentsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $experimentsClient->listExperiments($request);

        /** @var Experiment $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = ExperimentsClient::environmentName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[ENVIRONMENT]'
    );

    list_experiments_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\ExperimentsClient;
use Google\Cloud\Dialogflow\Cx\V3\Experiment;
use Google\Cloud\Dialogflow\Cx\V3\StartExperimentRequest;

/**
 * @param string $formattedName Resource name of the experiment to start.
 *                              Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/experiments/<ExperimentID>`. Please see
 *                              {@see ExperimentsClient::experimentName()} for help formatting this field.
 */
function start_experiment_sample(string $formattedName): void
{
    // Create a client.
    $experimentsClient = new ExperimentsClient();

    // Prepare the request message.
    $request = (new StartExperimentRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Experiment $response */
        $response = $experimentsClient->startExperiment($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ExperimentsClient::experimentName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[ENVIRONMENT]',
        '[EXPERIMENT]'
    );

    start_experiment_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\ExperimentsClient;
use Google\Cloud\Dialogflow\Cx\V3\Experiment;
use Google\Cloud\Dialogflow\Cx\V3\StopExperimentRequest;

/**
 * @param string $formattedName Resource name of the experiment to stop.
 *                              Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/experiments/<ExperimentID>`. Please see
 *                              {@see ExperimentsClient::experimentName()} for help formatting this field.
 */
function stop_experiment_sample(string $formattedName): void
{
    // Create a client.
    $experimentsClient = new ExperimentsClient();

    // Prepare the request message.
    $request = (new StopExperimentRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Experiment $response */
        $response = $experimentsClient->stopExperiment($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ExperimentsClient::experimentName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[ENVIRONMENT]',
        '[EXPERIMENT]'
    );

    stop_experiment_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\ExperimentsClient;
use Google\Cloud\Dialogflow\Cx\V3\Experiment;
use Google\Cloud\Dialogflow\Cx\V3\UpdateExperimentRequest;
use Google\Protobuf\FieldMask;

/**
 * @param string $experimentDisplayName The human-readable name of the experiment (unique in an
 *                                      environment). Limit of 64 characters.
 */
function update_experiment_sample(string $experimentDisplayName): void
{
    // Create a client.
    $experimentsClient = new ExperimentsClient();

    // Prepare the request message.
    $experiment = (new Experiment())
        ->setDisplayName($experimentDisplayName);
    $updateMask = new FieldMask();
    $request = (new UpdateExperimentRequest())
        ->setExperiment($experiment)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var Experiment $response */
        $response = $experimentsClient->updateExperiment($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $experimentDisplayName = '[DISPLAY_NAME]';

    update_experiment_sample($experimentDisplayName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\ExperimentsClient;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;

/**
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function get_location_sample(): void
{
    // Create a client.
    $experimentsClient = new ExperimentsClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $experimentsClient->getLocation($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\Cx\V3\Client\ExperimentsClient;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;

/**
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function list_locations_sample(): void
{
    // Create a client.
    $experimentsClient = new ExperimentsClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $experimentsClient->listLocations($request);

        /** @var Location $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}