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

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\TransitionRouteGroupsClient;
use Google\Cloud\Dialogflow\Cx\V3\CreateTransitionRouteGroupRequest;
use Google\Cloud\Dialogflow\Cx\V3\TransitionRouteGroup;

/**
 * @param string $formattedParent                 The flow to create an
 *                                                [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup]
 *                                                for. Format:
 *                                                `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`
 *                                                or `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`
 *                                                for agent-level groups. Please see
 *                                                {@see TransitionRouteGroupsClient::flowName()} for help formatting this field.
 * @param string $transitionRouteGroupDisplayName The human-readable name of the transition route group, unique
 *                                                within the flow. The display name can be no longer than 30 characters.
 */
function create_transition_route_group_sample(
    string $formattedParent,
    string $transitionRouteGroupDisplayName
): void {
    // Create a client.
    $transitionRouteGroupsClient = new TransitionRouteGroupsClient();

    // Prepare the request message.
    $transitionRouteGroup = (new TransitionRouteGroup())
        ->setDisplayName($transitionRouteGroupDisplayName);
    $request = (new CreateTransitionRouteGroupRequest())
        ->setParent($formattedParent)
        ->setTransitionRouteGroup($transitionRouteGroup);

    // Call the API and handle any network failures.
    try {
        /** @var TransitionRouteGroup $response */
        $response = $transitionRouteGroupsClient->createTransitionRouteGroup($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 = TransitionRouteGroupsClient::flowName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[FLOW]'
    );
    $transitionRouteGroupDisplayName = '[DISPLAY_NAME]';

    create_transition_route_group_sample($formattedParent, $transitionRouteGroupDisplayName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\TransitionRouteGroupsClient;
use Google\Cloud\Dialogflow\Cx\V3\DeleteTransitionRouteGroupRequest;

/**
 * @param string $formattedName The name of the
 *                              [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup]
 *                              to delete. Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>`
 *                              or
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>`. Please see
 *                              {@see TransitionRouteGroupsClient::transitionRouteGroupName()} for help formatting this field.
 */
function delete_transition_route_group_sample(string $formattedName): void
{
    // Create a client.
    $transitionRouteGroupsClient = new TransitionRouteGroupsClient();

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

    // Call the API and handle any network failures.
    try {
        $transitionRouteGroupsClient->deleteTransitionRouteGroup($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 = TransitionRouteGroupsClient::transitionRouteGroupName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[FLOW]',
        '[TRANSITION_ROUTE_GROUP]'
    );

    delete_transition_route_group_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\TransitionRouteGroupsClient;
use Google\Cloud\Dialogflow\Cx\V3\GetTransitionRouteGroupRequest;
use Google\Cloud\Dialogflow\Cx\V3\TransitionRouteGroup;

/**
 * @param string $formattedName The name of the
 *                              [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
 *                              Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>`
 *                              or
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>`. Please see
 *                              {@see TransitionRouteGroupsClient::transitionRouteGroupName()} for help formatting this field.
 */
function get_transition_route_group_sample(string $formattedName): void
{
    // Create a client.
    $transitionRouteGroupsClient = new TransitionRouteGroupsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var TransitionRouteGroup $response */
        $response = $transitionRouteGroupsClient->getTransitionRouteGroup($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 = TransitionRouteGroupsClient::transitionRouteGroupName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[FLOW]',
        '[TRANSITION_ROUTE_GROUP]'
    );

    get_transition_route_group_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\Cx\V3\Client\TransitionRouteGroupsClient;
use Google\Cloud\Dialogflow\Cx\V3\ListTransitionRouteGroupsRequest;
use Google\Cloud\Dialogflow\Cx\V3\TransitionRouteGroup;

/**
 * @param string $formattedParent The flow to list all transition route groups for.
 *                                Format:
 *                                `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`
 *                                or `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>. Please see
 *                                {@see TransitionRouteGroupsClient::flowName()} for help formatting this field.
 */
function list_transition_route_groups_sample(string $formattedParent): void
{
    // Create a client.
    $transitionRouteGroupsClient = new TransitionRouteGroupsClient();

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

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

        /** @var TransitionRouteGroup $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 = TransitionRouteGroupsClient::flowName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[FLOW]'
    );

    list_transition_route_groups_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\TransitionRouteGroupsClient;
use Google\Cloud\Dialogflow\Cx\V3\TransitionRouteGroup;
use Google\Cloud\Dialogflow\Cx\V3\UpdateTransitionRouteGroupRequest;

/**
 * @param string $transitionRouteGroupDisplayName The human-readable name of the transition route group, unique
 *                                                within the flow. The display name can be no longer than 30 characters.
 */
function update_transition_route_group_sample(string $transitionRouteGroupDisplayName): void
{
    // Create a client.
    $transitionRouteGroupsClient = new TransitionRouteGroupsClient();

    // Prepare the request message.
    $transitionRouteGroup = (new TransitionRouteGroup())
        ->setDisplayName($transitionRouteGroupDisplayName);
    $request = (new UpdateTransitionRouteGroupRequest())
        ->setTransitionRouteGroup($transitionRouteGroup);

    // Call the API and handle any network failures.
    try {
        /** @var TransitionRouteGroup $response */
        $response = $transitionRouteGroupsClient->updateTransitionRouteGroup($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
{
    $transitionRouteGroupDisplayName = '[DISPLAY_NAME]';

    update_transition_route_group_sample($transitionRouteGroupDisplayName);
}

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

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

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

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

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