Google Cloud Ids V1 Client - Class IDSClient (1.0.2)

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Ids\V1\Client\IDSClient;
use Google\Cloud\Ids\V1\CreateEndpointRequest;
use Google\Cloud\Ids\V1\Endpoint;
use Google\Cloud\Ids\V1\Endpoint\Severity;
use Google\Rpc\Status;

/**
 * @param string $formattedParent  The endpoint's parent. Please see
 *                                 {@see IDSClient::locationName()} for help formatting this field.
 * @param string $endpointId       The endpoint identifier. This will be part of the endpoint's
 *                                 resource name.
 *                                 This value must start with a lowercase letter followed by up to 62
 *                                 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
 *                                 Values that do not match this pattern will trigger an INVALID_ARGUMENT
 *                                 error.
 * @param string $endpointNetwork  The fully qualified URL of the network to which the IDS Endpoint is
 *                                 attached.
 * @param int    $endpointSeverity Lowest threat severity that this endpoint will alert on.
 */
function create_endpoint_sample(
    string $formattedParent,
    string $endpointId,
    string $endpointNetwork,
    int $endpointSeverity
): void {
    // Create a client.
    $iDSClient = new IDSClient();

    // Prepare the request message.
    $endpoint = (new Endpoint())
        ->setNetwork($endpointNetwork)
        ->setSeverity($endpointSeverity);
    $request = (new CreateEndpointRequest())
        ->setParent($formattedParent)
        ->setEndpointId($endpointId)
        ->setEndpoint($endpoint);

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

        if ($response->operationSucceeded()) {
            /** @var Endpoint $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 = IDSClient::locationName('[PROJECT]', '[LOCATION]');
    $endpointId = '[ENDPOINT_ID]';
    $endpointNetwork = '[NETWORK]';
    $endpointSeverity = Severity::SEVERITY_UNSPECIFIED;

    create_endpoint_sample($formattedParent, $endpointId, $endpointNetwork, $endpointSeverity);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Ids\V1\Client\IDSClient;
use Google\Cloud\Ids\V1\DeleteEndpointRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the endpoint to delete. Please see
 *                              {@see IDSClient::endpointName()} for help formatting this field.
 */
function delete_endpoint_sample(string $formattedName): void
{
    // Create a client.
    $iDSClient = new IDSClient();

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

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

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } 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 = IDSClient::endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]');

    delete_endpoint_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Ids\V1\Client\IDSClient;
use Google\Cloud\Ids\V1\Endpoint;
use Google\Cloud\Ids\V1\GetEndpointRequest;

/**
 * @param string $formattedName The name of the endpoint to retrieve.
 *                              Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
 *                              Please see {@see IDSClient::endpointName()} for help formatting this field.
 */
function get_endpoint_sample(string $formattedName): void
{
    // Create a client.
    $iDSClient = new IDSClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Endpoint $response */
        $response = $iDSClient->getEndpoint($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 = IDSClient::endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]');

    get_endpoint_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Ids\V1\Client\IDSClient;
use Google\Cloud\Ids\V1\Endpoint;
use Google\Cloud\Ids\V1\ListEndpointsRequest;

/**
 * @param string $formattedParent The parent, which owns this collection of endpoints. Please see
 *                                {@see IDSClient::locationName()} for help formatting this field.
 */
function list_endpoints_sample(string $formattedParent): void
{
    // Create a client.
    $iDSClient = new IDSClient();

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

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

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

    list_endpoints_sample($formattedParent);
}