Google Cloud Chronicle V1 Client - Class EntityServiceClient (0.1.2)

use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\Client\EntityServiceClient;
use Google\Cloud\Chronicle\V1\CreateWatchlistRequest;
use Google\Cloud\Chronicle\V1\Watchlist;
use Google\Cloud\Chronicle\V1\Watchlist\EntityPopulationMechanism;

/**
 * @param string $formattedParent      The parent resource where this watchlist will be created.
 *                                     Format: `projects/{project}/locations/{location}/instances/{instance}`
 *                                     Please see {@see EntityServiceClient::instanceName()} for help formatting this field.
 * @param string $watchlistDisplayName Display name of the watchlist.
 *                                     Note that it must be at least one character and less than 63 characters
 *                                     (https://google.aip.dev/148).
 */
function create_watchlist_sample(string $formattedParent, string $watchlistDisplayName): void
{
    // Create a client.
    $entityServiceClient = new EntityServiceClient();

    // Prepare the request message.
    $watchlistEntityPopulationMechanism = new EntityPopulationMechanism();
    $watchlist = (new Watchlist())
        ->setDisplayName($watchlistDisplayName)
        ->setEntityPopulationMechanism($watchlistEntityPopulationMechanism);
    $request = (new CreateWatchlistRequest())
        ->setParent($formattedParent)
        ->setWatchlist($watchlist);

    // Call the API and handle any network failures.
    try {
        /** @var Watchlist $response */
        $response = $entityServiceClient->createWatchlist($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 = EntityServiceClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
    $watchlistDisplayName = '[DISPLAY_NAME]';

    create_watchlist_sample($formattedParent, $watchlistDisplayName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\Client\EntityServiceClient;
use Google\Cloud\Chronicle\V1\DeleteWatchlistRequest;

/**
 * @param string $formattedName The name of the watchlist to delete.
 *                              Format:
 *                              `projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}`
 *                              Please see {@see EntityServiceClient::watchlistName()} for help formatting this field.
 */
function delete_watchlist_sample(string $formattedName): void
{
    // Create a client.
    $entityServiceClient = new EntityServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $entityServiceClient->deleteWatchlist($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 = EntityServiceClient::watchlistName(
        '[PROJECT]',
        '[LOCATION]',
        '[INSTANCE]',
        '[WATCHLIST]'
    );

    delete_watchlist_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\Client\EntityServiceClient;
use Google\Cloud\Chronicle\V1\GetWatchlistRequest;
use Google\Cloud\Chronicle\V1\Watchlist;

/**
 * @param string $formattedName The parent, which owns this collection of watchlists.
 *                              The name of the watchlist to retrieve.
 *                              Format:
 *                              `projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}`
 *                              Please see {@see EntityServiceClient::watchlistName()} for help formatting this field.
 */
function get_watchlist_sample(string $formattedName): void
{
    // Create a client.
    $entityServiceClient = new EntityServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Watchlist $response */
        $response = $entityServiceClient->getWatchlist($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 = EntityServiceClient::watchlistName(
        '[PROJECT]',
        '[LOCATION]',
        '[INSTANCE]',
        '[WATCHLIST]'
    );

    get_watchlist_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Chronicle\V1\Client\EntityServiceClient;
use Google\Cloud\Chronicle\V1\ListWatchlistsRequest;
use Google\Cloud\Chronicle\V1\Watchlist;

/**
 * @param string $formattedParent The parent, which owns this collection of watchlists.
 *                                Format: `projects/{project}/locations/{location}/instances/{instance}`
 *                                Please see {@see EntityServiceClient::instanceName()} for help formatting this field.
 */
function list_watchlists_sample(string $formattedParent): void
{
    // Create a client.
    $entityServiceClient = new EntityServiceClient();

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

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

        /** @var Watchlist $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 = EntityServiceClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');

    list_watchlists_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\Client\EntityServiceClient;
use Google\Cloud\Chronicle\V1\UpdateWatchlistRequest;
use Google\Cloud\Chronicle\V1\Watchlist;
use Google\Cloud\Chronicle\V1\Watchlist\EntityPopulationMechanism;

/**
 * @param string $watchlistDisplayName Display name of the watchlist.
 *                                     Note that it must be at least one character and less than 63 characters
 *                                     (https://google.aip.dev/148).
 */
function update_watchlist_sample(string $watchlistDisplayName): void
{
    // Create a client.
    $entityServiceClient = new EntityServiceClient();

    // Prepare the request message.
    $watchlistEntityPopulationMechanism = new EntityPopulationMechanism();
    $watchlist = (new Watchlist())
        ->setDisplayName($watchlistDisplayName)
        ->setEntityPopulationMechanism($watchlistEntityPopulationMechanism);
    $request = (new UpdateWatchlistRequest())
        ->setWatchlist($watchlist);

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

    update_watchlist_sample($watchlistDisplayName);
}