Google Cloud BeyondCorp Client Connector Services V1 Client - Class ClientConnectorServicesServiceClient (0.4.5)

Namespace

Methods

__construct

createClientConnectorService

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\ClientConnectorService;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\ClientConnectorService\Egress;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\ClientConnectorService\Ingress;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\Client\ClientConnectorServicesServiceClient;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\CreateClientConnectorServiceRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedParent            Value for parent. Please see
 *                                           {@see ClientConnectorServicesServiceClient::locationName()} for help formatting this field.
 * @param string $clientConnectorServiceName Name of resource. The name is ignored during creation.
 */
function create_client_connector_service_sample(
    string $formattedParent,
    string $clientConnectorServiceName
): void {
    // Create a client.
    $clientConnectorServicesServiceClient = new ClientConnectorServicesServiceClient();

    // Prepare the request message.
    $clientConnectorServiceIngress = new Ingress();
    $clientConnectorServiceEgress = new Egress();
    $clientConnectorService = (new ClientConnectorService())
        ->setName($clientConnectorServiceName)
        ->setIngress($clientConnectorServiceIngress)
        ->setEgress($clientConnectorServiceEgress);
    $request = (new CreateClientConnectorServiceRequest())
        ->setParent($formattedParent)
        ->setClientConnectorService($clientConnectorService);

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

        if ($response->operationSucceeded()) {
            /** @var ClientConnectorService $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 = ClientConnectorServicesServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $clientConnectorServiceName = '[NAME]';

    create_client_connector_service_sample($formattedParent, $clientConnectorServiceName);
}

deleteClientConnectorService

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\Client\ClientConnectorServicesServiceClient;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\DeleteClientConnectorServiceRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName Name of the resource. Please see
 *                              {@see ClientConnectorServicesServiceClient::clientConnectorServiceName()} for help formatting this field.
 */
function delete_client_connector_service_sample(string $formattedName): void
{
    // Create a client.
    $clientConnectorServicesServiceClient = new ClientConnectorServicesServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $clientConnectorServicesServiceClient->deleteClientConnectorService($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 = ClientConnectorServicesServiceClient::clientConnectorServiceName(
        '[PROJECT]',
        '[LOCATION]',
        '[CLIENT_CONNECTOR_SERVICE]'
    );

    delete_client_connector_service_sample($formattedName);
}

getClientConnectorService

use Google\ApiCore\ApiException;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\ClientConnectorService;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\Client\ClientConnectorServicesServiceClient;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\GetClientConnectorServiceRequest;

/**
 * @param string $formattedName Name of the resource. Please see
 *                              {@see ClientConnectorServicesServiceClient::clientConnectorServiceName()} for help formatting this field.
 */
function get_client_connector_service_sample(string $formattedName): void
{
    // Create a client.
    $clientConnectorServicesServiceClient = new ClientConnectorServicesServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var ClientConnectorService $response */
        $response = $clientConnectorServicesServiceClient->getClientConnectorService($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 = ClientConnectorServicesServiceClient::clientConnectorServiceName(
        '[PROJECT]',
        '[LOCATION]',
        '[CLIENT_CONNECTOR_SERVICE]'
    );

    get_client_connector_service_sample($formattedName);
}

listClientConnectorServices

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\ClientConnectorService;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\Client\ClientConnectorServicesServiceClient;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\ListClientConnectorServicesRequest;

/**
 * @param string $formattedParent Parent value for ListClientConnectorServicesRequest. Please see
 *                                {@see ClientConnectorServicesServiceClient::locationName()} for help formatting this field.
 */
function list_client_connector_services_sample(string $formattedParent): void
{
    // Create a client.
    $clientConnectorServicesServiceClient = new ClientConnectorServicesServiceClient();

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

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

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

    list_client_connector_services_sample($formattedParent);
}

updateClientConnectorService

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\ClientConnectorService;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\ClientConnectorService\Egress;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\ClientConnectorService\Ingress;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\Client\ClientConnectorServicesServiceClient;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\UpdateClientConnectorServiceRequest;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;

/**
 * @param string $clientConnectorServiceName Name of resource. The name is ignored during creation.
 */
function update_client_connector_service_sample(string $clientConnectorServiceName): void
{
    // Create a client.
    $clientConnectorServicesServiceClient = new ClientConnectorServicesServiceClient();

    // Prepare the request message.
    $updateMask = new FieldMask();
    $clientConnectorServiceIngress = new Ingress();
    $clientConnectorServiceEgress = new Egress();
    $clientConnectorService = (new ClientConnectorService())
        ->setName($clientConnectorServiceName)
        ->setIngress($clientConnectorServiceIngress)
        ->setEgress($clientConnectorServiceEgress);
    $request = (new UpdateClientConnectorServiceRequest())
        ->setUpdateMask($updateMask)
        ->setClientConnectorService($clientConnectorService);

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

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

    update_client_connector_service_sample($clientConnectorServiceName);
}

getLocation

use Google\ApiCore\ApiException;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\Client\ClientConnectorServicesServiceClient;
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.
    $clientConnectorServicesServiceClient = new ClientConnectorServicesServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $clientConnectorServicesServiceClient->getLocation($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

listLocations

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\Client\ClientConnectorServicesServiceClient;
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.
    $clientConnectorServicesServiceClient = new ClientConnectorServicesServiceClient();

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

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

getIamPolicy

use Google\ApiCore\ApiException;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\Client\ClientConnectorServicesServiceClient;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;

/**
 * @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.
    $clientConnectorServicesServiceClient = new ClientConnectorServicesServiceClient();

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

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

setIamPolicy

use Google\ApiCore\ApiException;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\Client\ClientConnectorServicesServiceClient;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;

/**
 * @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.
    $clientConnectorServicesServiceClient = new ClientConnectorServicesServiceClient();

    // 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 = $clientConnectorServicesServiceClient->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);
}

testIamPermissions

use Google\ApiCore\ApiException;
use Google\Cloud\BeyondCorp\ClientConnectorServices\V1\Client\ClientConnectorServicesServiceClient;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;

/**
 * @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.
    $clientConnectorServicesServiceClient = new ClientConnectorServicesServiceClient();

    // 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 = $clientConnectorServicesServiceClient->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);
}

createClientConnectorServiceAsync

deleteClientConnectorServiceAsync

getClientConnectorServiceAsync

listClientConnectorServicesAsync

updateClientConnectorServiceAsync

getLocationAsync

listLocationsAsync

getIamPolicyAsync

setIamPolicyAsync

testIamPermissionsAsync

getOperationsClient

resumeOperation

static::clientConnectorServiceName

static::locationName

static::parseName