Google Cloud Dialogflow Cx V3 Client - Class TestCasesClient (0.1.1)

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\TestCasesClient;

/**
 * @param string $formattedParent       The agent to delete test cases from.
 *                                      Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Please see
 *                                      {@see TestCasesClient::agentName()} for help formatting this field.
 * @param string $formattedNamesElement Format of test case names: `projects/<Project ID>/locations/
 *                                      <Location ID>/agents/<AgentID>/testCases/<TestCase ID>`. Please see
 *                                      {@see TestCasesClient::testCaseName()} for help formatting this field.
 */
function batch_delete_test_cases_sample(
    string $formattedParent,
    string $formattedNamesElement
): void {
    // Create a client.
    $testCasesClient = new TestCasesClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $formattedNames = [$formattedNamesElement,];

    // Call the API and handle any network failures.
    try {
        $testCasesClient->batchDeleteTestCases($formattedParent, $formattedNames);
        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
{
    $formattedParent = TestCasesClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');
    $formattedNamesElement = TestCasesClient::testCaseName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[TEST_CASE]'
    );

    batch_delete_test_cases_sample($formattedParent, $formattedNamesElement);
} 

 use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\Cx\V3\BatchRunTestCasesResponse;
use Google\Cloud\Dialogflow\Cx\V3\TestCasesClient;
use Google\Rpc\Status;

/**
 * @param string $formattedParent           Agent name. Format: `projects/<Project ID>/locations/<Location
 *                                          ID>/agents/ <AgentID>`. Please see
 *                                          {@see TestCasesClient::agentName()} for help formatting this field.
 * @param string $formattedTestCasesElement Format: `projects/<Project ID>/locations/<Location
 *                                          ID>/agents/<Agent ID>/testCases/<TestCase ID>`. Please see
 *                                          {@see TestCasesClient::testCaseName()} for help formatting this field.
 */
function batch_run_test_cases_sample(
    string $formattedParent,
    string $formattedTestCasesElement
): void {
    // Create a client.
    $testCasesClient = new TestCasesClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $formattedTestCases = [$formattedTestCasesElement,];

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $testCasesClient->batchRunTestCases($formattedParent, $formattedTestCases);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var BatchRunTestCasesResponse $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->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 = TestCasesClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');
    $formattedTestCasesElement = TestCasesClient::testCaseName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[TEST_CASE]'
    );

    batch_run_test_cases_sample($formattedParent, $formattedTestCasesElement);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\CalculateCoverageRequest\CoverageType;
use Google\Cloud\Dialogflow\Cx\V3\CalculateCoverageResponse;
use Google\Cloud\Dialogflow\Cx\V3\TestCasesClient;

/**
 * @param string $formattedAgent The agent to calculate coverage for.
 *                               Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Please see
 *                               {@see TestCasesClient::agentName()} for help formatting this field.
 * @param int    $type           The type of coverage requested.
 */
function calculate_coverage_sample(string $formattedAgent, int $type): void
{
    // Create a client.
    $testCasesClient = new TestCasesClient();

    // Call the API and handle any network failures.
    try {
        /** @var CalculateCoverageResponse $response */
        $response = $testCasesClient->calculateCoverage($formattedAgent, $type);
        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
{
    $formattedAgent = TestCasesClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');
    $type = CoverageType::COVERAGE_TYPE_UNSPECIFIED;

    calculate_coverage_sample($formattedAgent, $type);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\TestCase;
use Google\Cloud\Dialogflow\Cx\V3\TestCasesClient;

/**
 * @param string $formattedParent     The agent to create the test case for.
 *                                    Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Please see
 *                                    {@see TestCasesClient::agentName()} for help formatting this field.
 * @param string $testCaseDisplayName The human-readable name of the test case, unique within the
 *                                    agent. Limit of 200 characters.
 */
function create_test_case_sample(string $formattedParent, string $testCaseDisplayName): void
{
    // Create a client.
    $testCasesClient = new TestCasesClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $testCase = (new TestCase())
        ->setDisplayName($testCaseDisplayName);

    // Call the API and handle any network failures.
    try {
        /** @var TestCase $response */
        $response = $testCasesClient->createTestCase($formattedParent, $testCase);
        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 = TestCasesClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');
    $testCaseDisplayName = '[DISPLAY_NAME]';

    create_test_case_sample($formattedParent, $testCaseDisplayName);
} 

 use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\Cx\V3\ExportTestCasesResponse;
use Google\Cloud\Dialogflow\Cx\V3\TestCasesClient;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The agent where to export test cases from.
 *                                Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Please see
 *                                {@see TestCasesClient::agentName()} for help formatting this field.
 */
function export_test_cases_sample(string $formattedParent): void
{
    // Create a client.
    $testCasesClient = new TestCasesClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $testCasesClient->exportTestCases($formattedParent);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var ExportTestCasesResponse $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->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 = TestCasesClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');

    export_test_cases_sample($formattedParent);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\TestCase;
use Google\Cloud\Dialogflow\Cx\V3\TestCasesClient;

/**
 * @param string $formattedName The name of the testcase.
 *                              Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 *                              ID>/testCases/<TestCase ID>`. Please see
 *                              {@see TestCasesClient::testCaseName()} for help formatting this field.
 */
function get_test_case_sample(string $formattedName): void
{
    // Create a client.
    $testCasesClient = new TestCasesClient();

    // Call the API and handle any network failures.
    try {
        /** @var TestCase $response */
        $response = $testCasesClient->getTestCase($formattedName);
        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 = TestCasesClient::testCaseName('[PROJECT]', '[LOCATION]', '[AGENT]', '[TEST_CASE]');

    get_test_case_sample($formattedName);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\TestCaseResult;
use Google\Cloud\Dialogflow\Cx\V3\TestCasesClient;

/**
 * @param string $formattedName The name of the testcase.
 *                              Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 *                              ID>/testCases/<TestCase ID>/results/<TestCaseResult ID>`. Please see
 *                              {@see TestCasesClient::testCaseResultName()} for help formatting this field.
 */
function get_test_case_result_sample(string $formattedName): void
{
    // Create a client.
    $testCasesClient = new TestCasesClient();

    // Call the API and handle any network failures.
    try {
        /** @var TestCaseResult $response */
        $response = $testCasesClient->getTestCaseResult($formattedName);
        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 = TestCasesClient::testCaseResultName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[TEST_CASE]',
        '[RESULT]'
    );

    get_test_case_result_sample($formattedName);
} 

 use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\Cx\V3\ImportTestCasesResponse;
use Google\Cloud\Dialogflow\Cx\V3\TestCasesClient;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The agent to import test cases to.
 *                                Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Please see
 *                                {@see TestCasesClient::agentName()} for help formatting this field.
 */
function import_test_cases_sample(string $formattedParent): void
{
    // Create a client.
    $testCasesClient = new TestCasesClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $testCasesClient->importTestCases($formattedParent);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var ImportTestCasesResponse $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->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 = TestCasesClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');

    import_test_cases_sample($formattedParent);
} 

 use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\Cx\V3\TestCaseResult;
use Google\Cloud\Dialogflow\Cx\V3\TestCasesClient;

/**
 * @param string $formattedParent The test case to list results for.
 *                                Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/
 *                                testCases/<TestCase ID>`. Specify a `-` as a wildcard for TestCase ID to
 *                                list results across multiple test cases. Please see
 *                                {@see TestCasesClient::testCaseName()} for help formatting this field.
 */
function list_test_case_results_sample(string $formattedParent): void
{
    // Create a client.
    $testCasesClient = new TestCasesClient();

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

        /** @var TestCaseResult $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 = TestCasesClient::testCaseName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[TEST_CASE]'
    );

    list_test_case_results_sample($formattedParent);
} 

 use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\Cx\V3\TestCase;
use Google\Cloud\Dialogflow\Cx\V3\TestCasesClient;

/**
 * @param string $formattedParent The agent to list all pages for.
 *                                Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Please see
 *                                {@see TestCasesClient::agentName()} for help formatting this field.
 */
function list_test_cases_sample(string $formattedParent): void
{
    // Create a client.
    $testCasesClient = new TestCasesClient();

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

        /** @var TestCase $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 = TestCasesClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');

    list_test_cases_sample($formattedParent);
} 

 use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\Cx\V3\RunTestCaseResponse;
use Google\Cloud\Dialogflow\Cx\V3\TestCasesClient;
use Google\Rpc\Status;

/**
 * @param string $formattedName Format of test case name to run: `projects/<Project
 *                              ID>/locations/ <Location ID>/agents/<AgentID>/testCases/<TestCase ID>`. Please see
 *                              {@see TestCasesClient::testCaseName()} for help formatting this field.
 */
function run_test_case_sample(string $formattedName): void
{
    // Create a client.
    $testCasesClient = new TestCasesClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $testCasesClient->runTestCase($formattedName);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var RunTestCaseResponse $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->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 = TestCasesClient::testCaseName('[PROJECT]', '[LOCATION]', '[AGENT]', '[TEST_CASE]');

    run_test_case_sample($formattedName);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\TestCase;
use Google\Cloud\Dialogflow\Cx\V3\TestCasesClient;
use Google\Protobuf\FieldMask;

/**
 * @param string $testCaseDisplayName The human-readable name of the test case, unique within the
 *                                    agent. Limit of 200 characters.
 */
function update_test_case_sample(string $testCaseDisplayName): void
{
    // Create a client.
    $testCasesClient = new TestCasesClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $testCase = (new TestCase())
        ->setDisplayName($testCaseDisplayName);
    $updateMask = new FieldMask();

    // Call the API and handle any network failures.
    try {
        /** @var TestCase $response */
        $response = $testCasesClient->updateTestCase($testCase, $updateMask);
        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
{
    $testCaseDisplayName = '[DISPLAY_NAME]';

    update_test_case_sample($testCaseDisplayName);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\TestCasesClient;
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.
    $testCasesClient = new TestCasesClient();

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $testCasesClient->getLocation();
        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\TestCasesClient;
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.
    $testCasesClient = new TestCasesClient();

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

        /** @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());
    }
}