Google Cloud Dialogflow V2 Client - Class CompanionAgentsClient (2.8.0)

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\CompanionAgentsClient;
use Google\Cloud\Dialogflow\V2\CompanionAgent;
use Google\Cloud\Dialogflow\V2\CreateCompanionAgentRequest;

/**
 * @param string $formattedParent Resource identifier of the project creating the companion agent.
 *                                Format: `projects/{project}/locations/{location}`
 *                                Please see {@see CompanionAgentsClient::locationName()} for help formatting this field.
 */
function create_companion_agent_sample(string $formattedParent): void
{
    // Create a client.
    $companionAgentsClient = new CompanionAgentsClient();

    // Prepare the request message.
    $companionAgent = new CompanionAgent();
    $request = (new CreateCompanionAgentRequest())
        ->setParent($formattedParent)
        ->setCompanionAgent($companionAgent);

    // Call the API and handle any network failures.
    try {
        /** @var CompanionAgent $response */
        $response = $companionAgentsClient->createCompanionAgent($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 = CompanionAgentsClient::locationName('[PROJECT]', '[LOCATION]');

    create_companion_agent_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\CompanionAgentsClient;
use Google\Cloud\Dialogflow\V2\DeleteCompanionAgentRequest;

/**
 * @param string $formattedName The unique resource identifier of the CompanionAgent to delete.
 *                              Format:
 *                              `projects/{project}/locations/{location}/companionAgents/{companion_agent}`. Please see
 *                              {@see CompanionAgentsClient::companionAgentName()} for help formatting this field.
 */
function delete_companion_agent_sample(string $formattedName): void
{
    // Create a client.
    $companionAgentsClient = new CompanionAgentsClient();

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

    // Call the API and handle any network failures.
    try {
        $companionAgentsClient->deleteCompanionAgent($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 = CompanionAgentsClient::companionAgentName(
        '[PROJECT]',
        '[LOCATION]',
        '[COMPANION_AGENT]'
    );

    delete_companion_agent_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\CompanionAgentsClient;
use Google\Cloud\Dialogflow\V2\CompanionAgent;
use Google\Cloud\Dialogflow\V2\GetCompanionAgentRequest;

/**
 * @param string $formattedName The unique resource identifier of the CompanionAgent to get all
 *                              information for. Format:
 *                              `projects/{project}/locations/{location}/companionAgents/{companion_agent}`.
 *                              Contains the information about the {project}, {location}, and
 *                              {companion_agent}. Please see
 *                              {@see CompanionAgentsClient::companionAgentName()} for help formatting this field.
 */
function get_companion_agent_sample(string $formattedName): void
{
    // Create a client.
    $companionAgentsClient = new CompanionAgentsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var CompanionAgent $response */
        $response = $companionAgentsClient->getCompanionAgent($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 = CompanionAgentsClient::companionAgentName(
        '[PROJECT]',
        '[LOCATION]',
        '[COMPANION_AGENT]'
    );

    get_companion_agent_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\Client\CompanionAgentsClient;
use Google\Cloud\Dialogflow\V2\CompanionAgent;
use Google\Cloud\Dialogflow\V2\ListCompanionAgentsRequest;

/**
 * @param string $formattedParent The parent resource name to list the companion agents for.
 *                                Format: `projects/{project}/locations/{location}`
 *                                Please see {@see CompanionAgentsClient::locationName()} for help formatting this field.
 */
function list_companion_agents_sample(string $formattedParent): void
{
    // Create a client.
    $companionAgentsClient = new CompanionAgentsClient();

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

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

        /** @var CompanionAgent $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 = CompanionAgentsClient::locationName('[PROJECT]', '[LOCATION]');

    list_companion_agents_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\CompanionAgentsClient;
use Google\Cloud\Dialogflow\V2\CompanionAgent;
use Google\Cloud\Dialogflow\V2\UpdateCompanionAgentRequest;

/**
 * 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 update_companion_agent_sample(): void
{
    // Create a client.
    $companionAgentsClient = new CompanionAgentsClient();

    // Prepare the request message.
    $companionAgent = new CompanionAgent();
    $request = (new UpdateCompanionAgentRequest())
        ->setCompanionAgent($companionAgent);

    // Call the API and handle any network failures.
    try {
        /** @var CompanionAgent $response */
        $response = $companionAgentsClient->updateCompanionAgent($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\Cloud\Dialogflow\V2\Client\CompanionAgentsClient;
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.
    $companionAgentsClient = new CompanionAgentsClient();

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

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

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $companionAgentsClient->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());
    }
}