Google Cloud Dialogflow Cx V3 Client - Class PlaybooksClient (0.11.1)

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\PlaybooksClient;
use Google\Cloud\Dialogflow\Cx\V3\CreatePlaybookRequest;
use Google\Cloud\Dialogflow\Cx\V3\Playbook;

/**
 * @param string $formattedParent     The agent to create a playbook for.
 *                                    Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`. Please see
 *                                    {@see PlaybooksClient::agentName()} for help formatting this field.
 * @param string $playbookDisplayName The human-readable name of the playbook, unique within an agent.
 * @param string $playbookGoal        High level description of the goal the playbook intend to
 *                                    accomplish. A goal should be concise since it's visible to other playbooks
 *                                    that may reference this playbook.
 */
function create_playbook_sample(
    string $formattedParent,
    string $playbookDisplayName,
    string $playbookGoal
): void {
    // Create a client.
    $playbooksClient = new PlaybooksClient();

    // Prepare the request message.
    $playbook = (new Playbook())
        ->setDisplayName($playbookDisplayName)
        ->setGoal($playbookGoal);
    $request = (new CreatePlaybookRequest())
        ->setParent($formattedParent)
        ->setPlaybook($playbook);

    // Call the API and handle any network failures.
    try {
        /** @var Playbook $response */
        $response = $playbooksClient->createPlaybook($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 = PlaybooksClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');
    $playbookDisplayName = '[DISPLAY_NAME]';
    $playbookGoal = '[GOAL]';

    create_playbook_sample($formattedParent, $playbookDisplayName, $playbookGoal);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\PlaybooksClient;
use Google\Cloud\Dialogflow\Cx\V3\CreatePlaybookVersionRequest;
use Google\Cloud\Dialogflow\Cx\V3\PlaybookVersion;

/**
 * @param string $formattedParent The playbook to create a version for.
 *                                Format:
 *                                `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`. Please see
 *                                {@see PlaybooksClient::playbookName()} for help formatting this field.
 */
function create_playbook_version_sample(string $formattedParent): void
{
    // Create a client.
    $playbooksClient = new PlaybooksClient();

    // Prepare the request message.
    $playbookVersion = new PlaybookVersion();
    $request = (new CreatePlaybookVersionRequest())
        ->setParent($formattedParent)
        ->setPlaybookVersion($playbookVersion);

    // Call the API and handle any network failures.
    try {
        /** @var PlaybookVersion $response */
        $response = $playbooksClient->createPlaybookVersion($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 = PlaybooksClient::playbookName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[PLAYBOOK]'
    );

    create_playbook_version_sample($formattedParent);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\PlaybooksClient;
use Google\Cloud\Dialogflow\Cx\V3\DeletePlaybookRequest;

/**
 * @param string $formattedName The name of the playbook to delete.
 *                              Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`. Please see
 *                              {@see PlaybooksClient::playbookName()} for help formatting this field.
 */
function delete_playbook_sample(string $formattedName): void
{
    // Create a client.
    $playbooksClient = new PlaybooksClient();

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

    // Call the API and handle any network failures.
    try {
        $playbooksClient->deletePlaybook($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 = PlaybooksClient::playbookName('[PROJECT]', '[LOCATION]', '[AGENT]', '[PLAYBOOK]');

    delete_playbook_sample($formattedName);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\PlaybooksClient;
use Google\Cloud\Dialogflow\Cx\V3\DeletePlaybookVersionRequest;

/**
 * @param string $formattedName The name of the playbook version to delete.
 *                              Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`. Please see
 *                              {@see PlaybooksClient::playbookVersionName()} for help formatting this field.
 */
function delete_playbook_version_sample(string $formattedName): void
{
    // Create a client.
    $playbooksClient = new PlaybooksClient();

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

    // Call the API and handle any network failures.
    try {
        $playbooksClient->deletePlaybookVersion($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 = PlaybooksClient::playbookVersionName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[PLAYBOOK]',
        '[VERSION]'
    );

    delete_playbook_version_sample($formattedName);
} 

 use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\Cx\V3\Client\PlaybooksClient;
use Google\Cloud\Dialogflow\Cx\V3\ExportPlaybookRequest;
use Google\Cloud\Dialogflow\Cx\V3\ExportPlaybookResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the playbook to export.
 *                              Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`. Please see
 *                              {@see PlaybooksClient::playbookName()} for help formatting this field.
 */
function export_playbook_sample(string $formattedName): void
{
    // Create a client.
    $playbooksClient = new PlaybooksClient();

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

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

        if ($response->operationSucceeded()) {
            /** @var ExportPlaybookResponse $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 = PlaybooksClient::playbookName('[PROJECT]', '[LOCATION]', '[AGENT]', '[PLAYBOOK]');

    export_playbook_sample($formattedName);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\PlaybooksClient;
use Google\Cloud\Dialogflow\Cx\V3\GetPlaybookRequest;
use Google\Cloud\Dialogflow\Cx\V3\Playbook;

/**
 * @param string $formattedName The name of the playbook.
 *                              Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`. Please see
 *                              {@see PlaybooksClient::playbookName()} for help formatting this field.
 */
function get_playbook_sample(string $formattedName): void
{
    // Create a client.
    $playbooksClient = new PlaybooksClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Playbook $response */
        $response = $playbooksClient->getPlaybook($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 = PlaybooksClient::playbookName('[PROJECT]', '[LOCATION]', '[AGENT]', '[PLAYBOOK]');

    get_playbook_sample($formattedName);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\PlaybooksClient;
use Google\Cloud\Dialogflow\Cx\V3\GetPlaybookVersionRequest;
use Google\Cloud\Dialogflow\Cx\V3\PlaybookVersion;

/**
 * @param string $formattedName The name of the playbook version.
 *                              Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`. Please see
 *                              {@see PlaybooksClient::playbookVersionName()} for help formatting this field.
 */
function get_playbook_version_sample(string $formattedName): void
{
    // Create a client.
    $playbooksClient = new PlaybooksClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PlaybookVersion $response */
        $response = $playbooksClient->getPlaybookVersion($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 = PlaybooksClient::playbookVersionName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[PLAYBOOK]',
        '[VERSION]'
    );

    get_playbook_version_sample($formattedName);
} 

 use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\Cx\V3\Client\PlaybooksClient;
use Google\Cloud\Dialogflow\Cx\V3\ImportPlaybookRequest;
use Google\Cloud\Dialogflow\Cx\V3\ImportPlaybookResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The agent to import the playbook into.
 *                                Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`. Please see
 *                                {@see PlaybooksClient::agentName()} for help formatting this field.
 */
function import_playbook_sample(string $formattedParent): void
{
    // Create a client.
    $playbooksClient = new PlaybooksClient();

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

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

        if ($response->operationSucceeded()) {
            /** @var ImportPlaybookResponse $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 = PlaybooksClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');

    import_playbook_sample($formattedParent);
} 

 use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\Cx\V3\Client\PlaybooksClient;
use Google\Cloud\Dialogflow\Cx\V3\ListPlaybookVersionsRequest;
use Google\Cloud\Dialogflow\Cx\V3\PlaybookVersion;

/**
 * @param string $formattedParent The playbook to list versions for.
 *                                Format:
 *                                `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`. Please see
 *                                {@see PlaybooksClient::playbookName()} for help formatting this field.
 */
function list_playbook_versions_sample(string $formattedParent): void
{
    // Create a client.
    $playbooksClient = new PlaybooksClient();

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

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

        /** @var PlaybookVersion $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 = PlaybooksClient::playbookName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[PLAYBOOK]'
    );

    list_playbook_versions_sample($formattedParent);
} 

 use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\Cx\V3\Client\PlaybooksClient;
use Google\Cloud\Dialogflow\Cx\V3\ListPlaybooksRequest;
use Google\Cloud\Dialogflow\Cx\V3\Playbook;

/**
 * @param string $formattedParent The agent to list playbooks from.
 *                                Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`. Please see
 *                                {@see PlaybooksClient::agentName()} for help formatting this field.
 */
function list_playbooks_sample(string $formattedParent): void
{
    // Create a client.
    $playbooksClient = new PlaybooksClient();

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

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

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

    list_playbooks_sample($formattedParent);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\PlaybooksClient;
use Google\Cloud\Dialogflow\Cx\V3\RestorePlaybookVersionRequest;
use Google\Cloud\Dialogflow\Cx\V3\RestorePlaybookVersionResponse;

/**
 * @param string $formattedName The name of the playbook version.
 *                              Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`. Please see
 *                              {@see PlaybooksClient::playbookVersionName()} for help formatting this field.
 */
function restore_playbook_version_sample(string $formattedName): void
{
    // Create a client.
    $playbooksClient = new PlaybooksClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var RestorePlaybookVersionResponse $response */
        $response = $playbooksClient->restorePlaybookVersion($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 = PlaybooksClient::playbookVersionName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[PLAYBOOK]',
        '[VERSION]'
    );

    restore_playbook_version_sample($formattedName);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\PlaybooksClient;
use Google\Cloud\Dialogflow\Cx\V3\Playbook;
use Google\Cloud\Dialogflow\Cx\V3\UpdatePlaybookRequest;

/**
 * @param string $playbookDisplayName The human-readable name of the playbook, unique within an agent.
 * @param string $playbookGoal        High level description of the goal the playbook intend to
 *                                    accomplish. A goal should be concise since it's visible to other playbooks
 *                                    that may reference this playbook.
 */
function update_playbook_sample(string $playbookDisplayName, string $playbookGoal): void
{
    // Create a client.
    $playbooksClient = new PlaybooksClient();

    // Prepare the request message.
    $playbook = (new Playbook())
        ->setDisplayName($playbookDisplayName)
        ->setGoal($playbookGoal);
    $request = (new UpdatePlaybookRequest())
        ->setPlaybook($playbook);

    // Call the API and handle any network failures.
    try {
        /** @var Playbook $response */
        $response = $playbooksClient->updatePlaybook($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
{
    $playbookDisplayName = '[DISPLAY_NAME]';
    $playbookGoal = '[GOAL]';

    update_playbook_sample($playbookDisplayName, $playbookGoal);
} 

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

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

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

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

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