Google Cloud Network Management V1 Client - Class ReachabilityServiceClient (1.7.3)

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkManagement\V1\Client\ReachabilityServiceClient;
use Google\Cloud\NetworkManagement\V1\ConnectivityTest;
use Google\Cloud\NetworkManagement\V1\CreateConnectivityTestRequest;
use Google\Cloud\NetworkManagement\V1\Endpoint;
use Google\Rpc\Status;

/**
 * @param string $parent       The parent resource of the Connectivity Test to create:
 *                             `projects/{project_id}/locations/global`
 * @param string $testId       The logical name of the Connectivity Test in your project
 *                             with the following restrictions:
 *
 *                             * Must contain only lowercase letters, numbers, and hyphens.
 *                             * Must start with a letter.
 *                             * Must be between 1-40 characters.
 *                             * Must end with a number or a letter.
 *                             * Must be unique within the customer project
 * @param string $resourceName Unique name of the resource using the form:
 *                             `projects/{project_id}/locations/global/connectivityTests/{test_id}`
 */
function create_connectivity_test_sample(
    string $parent,
    string $testId,
    string $resourceName
): void {
    // Create a client.
    $reachabilityServiceClient = new ReachabilityServiceClient();

    // Prepare the request message.
    $resourceSource = new Endpoint();
    $resourceDestination = new Endpoint();
    $resource = (new ConnectivityTest())
        ->setName($resourceName)
        ->setSource($resourceSource)
        ->setDestination($resourceDestination);
    $request = (new CreateConnectivityTestRequest())
        ->setParent($parent)
        ->setTestId($testId)
        ->setResource($resource);

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

        if ($response->operationSucceeded()) {
            /** @var ConnectivityTest $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
{
    $parent = '[PARENT]';
    $testId = '[TEST_ID]';
    $resourceName = '[NAME]';

    create_connectivity_test_sample($parent, $testId, $resourceName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkManagement\V1\Client\ReachabilityServiceClient;
use Google\Cloud\NetworkManagement\V1\DeleteConnectivityTestRequest;
use Google\Rpc\Status;

/**
 * @param string $name Connectivity Test resource name using the form:
 *                     `projects/{project_id}/locations/global/connectivityTests/{test_id}`
 */
function delete_connectivity_test_sample(string $name): void
{
    // Create a client.
    $reachabilityServiceClient = new ReachabilityServiceClient();

    // Prepare the request message.
    $request = (new DeleteConnectivityTestRequest())
        ->setName($name);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $reachabilityServiceClient->deleteConnectivityTest($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
{
    $name = '[NAME]';

    delete_connectivity_test_sample($name);
}

use Google\ApiCore\ApiException;
use Google\Cloud\NetworkManagement\V1\Client\ReachabilityServiceClient;
use Google\Cloud\NetworkManagement\V1\ConnectivityTest;
use Google\Cloud\NetworkManagement\V1\GetConnectivityTestRequest;

/**
 * @param string $name `ConnectivityTest` resource name using the form:
 *                     `projects/{project_id}/locations/global/connectivityTests/{test_id}`
 */
function get_connectivity_test_sample(string $name): void
{
    // Create a client.
    $reachabilityServiceClient = new ReachabilityServiceClient();

    // Prepare the request message.
    $request = (new GetConnectivityTestRequest())
        ->setName($name);

    // Call the API and handle any network failures.
    try {
        /** @var ConnectivityTest $response */
        $response = $reachabilityServiceClient->getConnectivityTest($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
{
    $name = '[NAME]';

    get_connectivity_test_sample($name);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\NetworkManagement\V1\Client\ReachabilityServiceClient;
use Google\Cloud\NetworkManagement\V1\ConnectivityTest;
use Google\Cloud\NetworkManagement\V1\ListConnectivityTestsRequest;

/**
 * @param string $parent The parent resource of the Connectivity Tests:
 *                       `projects/{project_id}/locations/global`
 */
function list_connectivity_tests_sample(string $parent): void
{
    // Create a client.
    $reachabilityServiceClient = new ReachabilityServiceClient();

    // Prepare the request message.
    $request = (new ListConnectivityTestsRequest())
        ->setParent($parent);

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

        /** @var ConnectivityTest $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
{
    $parent = '[PARENT]';

    list_connectivity_tests_sample($parent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkManagement\V1\Client\ReachabilityServiceClient;
use Google\Cloud\NetworkManagement\V1\ConnectivityTest;
use Google\Cloud\NetworkManagement\V1\RerunConnectivityTestRequest;
use Google\Rpc\Status;

/**
 * @param string $name Connectivity Test resource name using the form:
 *                     `projects/{project_id}/locations/global/connectivityTests/{test_id}`
 */
function rerun_connectivity_test_sample(string $name): void
{
    // Create a client.
    $reachabilityServiceClient = new ReachabilityServiceClient();

    // Prepare the request message.
    $request = (new RerunConnectivityTestRequest())
        ->setName($name);

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

        if ($response->operationSucceeded()) {
            /** @var ConnectivityTest $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
{
    $name = '[NAME]';

    rerun_connectivity_test_sample($name);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkManagement\V1\Client\ReachabilityServiceClient;
use Google\Cloud\NetworkManagement\V1\ConnectivityTest;
use Google\Cloud\NetworkManagement\V1\Endpoint;
use Google\Cloud\NetworkManagement\V1\UpdateConnectivityTestRequest;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;

/**
 * @param string $resourceName Unique name of the resource using the form:
 *                             `projects/{project_id}/locations/global/connectivityTests/{test_id}`
 */
function update_connectivity_test_sample(string $resourceName): void
{
    // Create a client.
    $reachabilityServiceClient = new ReachabilityServiceClient();

    // Prepare the request message.
    $updateMask = new FieldMask();
    $resourceSource = new Endpoint();
    $resourceDestination = new Endpoint();
    $resource = (new ConnectivityTest())
        ->setName($resourceName)
        ->setSource($resourceSource)
        ->setDestination($resourceDestination);
    $request = (new UpdateConnectivityTestRequest())
        ->setUpdateMask($updateMask)
        ->setResource($resource);

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

        if ($response->operationSucceeded()) {
            /** @var ConnectivityTest $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
{
    $resourceName = '[NAME]';

    update_connectivity_test_sample($resourceName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\NetworkManagement\V1\Client\ReachabilityServiceClient;

/**
 * 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.
    $reachabilityServiceClient = new ReachabilityServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $reachabilityServiceClient->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\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\NetworkManagement\V1\Client\ReachabilityServiceClient;

/**
 * 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.
    $reachabilityServiceClient = new ReachabilityServiceClient();

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

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

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\NetworkManagement\V1\Client\ReachabilityServiceClient;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being requested.
 *                         See the operation documentation for the appropriate value for this field.
 */
function get_iam_policy_sample(string $resource): void
{
    // Create a client.
    $reachabilityServiceClient = new ReachabilityServiceClient();

    // Prepare the request message.
    $request = (new GetIamPolicyRequest())
        ->setResource($resource);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $reachabilityServiceClient->getIamPolicy($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
{
    $resource = '[RESOURCE]';

    get_iam_policy_sample($resource);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
use Google\Cloud\NetworkManagement\V1\Client\ReachabilityServiceClient;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being specified.
 *                         See the operation documentation for the appropriate value for this field.
 */
function set_iam_policy_sample(string $resource): void
{
    // Create a client.
    $reachabilityServiceClient = new ReachabilityServiceClient();

    // Prepare the request message.
    $policy = new Policy();
    $request = (new SetIamPolicyRequest())
        ->setResource($resource)
        ->setPolicy($policy);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $reachabilityServiceClient->setIamPolicy($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
{
    $resource = '[RESOURCE]';

    set_iam_policy_sample($resource);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\NetworkManagement\V1\Client\ReachabilityServiceClient;

/**
 * @param string $resource           REQUIRED: The resource for which the policy detail is being requested.
 *                                   See the operation documentation for the appropriate value for this field.
 * @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
 *                                   wildcards (such as '*' or 'storage.*') are not allowed. For more
 *                                   information see
 *                                   [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
 */
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
    // Create a client.
    $reachabilityServiceClient = new ReachabilityServiceClient();

    // Prepare the request message.
    $permissions = [$permissionsElement,];
    $request = (new TestIamPermissionsRequest())
        ->setResource($resource)
        ->setPermissions($permissions);

    // Call the API and handle any network failures.
    try {
        /** @var TestIamPermissionsResponse $response */
        $response = $reachabilityServiceClient->testIamPermissions($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
{
    $resource = '[RESOURCE]';
    $permissionsElement = '[PERMISSIONS]';

    test_iam_permissions_sample($resource, $permissionsElement);
}