Reference documentation and code samples for the Google Cloud BeyondCorp Client Connector Services V1 Client class ClientConnectorServicesServiceClient.
Service Description: API Overview:
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ BeyondCorp \ ClientConnectorServices \ V1 \ ClientMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description | 
| options | arrayOptional. Options for configuring the service API wrapper. | 
| ↳ apiEndpoint | stringThe address of the API remote host. May optionally include the port, formatted as " 
 | 
| ↳ credentials | string|array|FetchAuthTokenInterface|CredentialsWrapperThe credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. | 
| ↳ credentialsConfig | arrayOptions used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . | 
| ↳ disableRetries | boolDetermines whether or not retries defined by the client configuration should be disabled. Defaults to  | 
| ↳ clientConfig | string|arrayClient method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. | 
| ↳ transport | string|TransportInterfaceThe transport used for executing network requests. May be either the string  | 
| ↳ transportConfig | arrayConfiguration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. | 
| ↳ clientCertSource | callableA callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. | 
createClientConnectorService
Creates a new ClientConnectorService in a given project and location.
The async variant is Google\Cloud\BeyondCorp\ClientConnectorServices\V1\Client\BaseClient\self::createClientConnectorServiceAsync() .
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\BeyondCorp\ClientConnectorServices\V1\CreateClientConnectorServiceRequestA request to house fields associated with the call. | 
| callOptions | arrayOptional. | 
| ↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. | 
| Returns | |
|---|---|
| Type | Description | 
| Google\ApiCore\OperationResponse | |
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
Deletes a single ClientConnectorService.
The async variant is Google\Cloud\BeyondCorp\ClientConnectorServices\V1\Client\BaseClient\self::deleteClientConnectorServiceAsync() .
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\BeyondCorp\ClientConnectorServices\V1\DeleteClientConnectorServiceRequestA request to house fields associated with the call. | 
| callOptions | arrayOptional. | 
| ↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. | 
| Returns | |
|---|---|
| Type | Description | 
| Google\ApiCore\OperationResponse | |
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
Gets details of a single ClientConnectorService.
The async variant is Google\Cloud\BeyondCorp\ClientConnectorServices\V1\Client\BaseClient\self::getClientConnectorServiceAsync() .
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\BeyondCorp\ClientConnectorServices\V1\GetClientConnectorServiceRequestA request to house fields associated with the call. | 
| callOptions | arrayOptional. | 
| ↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. | 
| Returns | |
|---|---|
| Type | Description | 
| Google\Cloud\BeyondCorp\ClientConnectorServices\V1\ClientConnectorService | |
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
Lists ClientConnectorServices in a given project and location.
The async variant is Google\Cloud\BeyondCorp\ClientConnectorServices\V1\Client\BaseClient\self::listClientConnectorServicesAsync() .
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\BeyondCorp\ClientConnectorServices\V1\ListClientConnectorServicesRequestA request to house fields associated with the call. | 
| callOptions | arrayOptional. | 
| ↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. | 
| Returns | |
|---|---|
| Type | Description | 
| Google\ApiCore\PagedListResponse | |
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
Updates the parameters of a single ClientConnectorService.
The async variant is Google\Cloud\BeyondCorp\ClientConnectorServices\V1\Client\BaseClient\self::updateClientConnectorServiceAsync() .
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\BeyondCorp\ClientConnectorServices\V1\UpdateClientConnectorServiceRequestA request to house fields associated with the call. | 
| callOptions | arrayOptional. | 
| ↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. | 
| Returns | |
|---|---|
| Type | Description | 
| Google\ApiCore\OperationResponse | |
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
Gets information about a location.
The async variant is Google\Cloud\BeyondCorp\ClientConnectorServices\V1\Client\BaseClient\self::getLocationAsync() .
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\Location\GetLocationRequestA request to house fields associated with the call. | 
| callOptions | arrayOptional. | 
| ↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. | 
| Returns | |
|---|---|
| Type | Description | 
| Google\Cloud\Location\Location | |
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
Lists information about the supported locations for this service.
The async variant is Google\Cloud\BeyondCorp\ClientConnectorServices\V1\Client\BaseClient\self::listLocationsAsync() .
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\Location\ListLocationsRequestA request to house fields associated with the call. | 
| callOptions | arrayOptional. | 
| ↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. | 
| Returns | |
|---|---|
| Type | Description | 
| Google\ApiCore\PagedListResponse | |
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
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
The async variant is Google\Cloud\BeyondCorp\ClientConnectorServices\V1\Client\BaseClient\self::getIamPolicyAsync() .
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\Iam\V1\GetIamPolicyRequestA request to house fields associated with the call. | 
| callOptions | arrayOptional. | 
| ↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. | 
| Returns | |
|---|---|
| Type | Description | 
| Google\Cloud\Iam\V1\Policy | |
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
Sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED
errors.
The async variant is Google\Cloud\BeyondCorp\ClientConnectorServices\V1\Client\BaseClient\self::setIamPolicyAsync() .
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\Iam\V1\SetIamPolicyRequestA request to house fields associated with the call. | 
| callOptions | arrayOptional. | 
| ↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. | 
| Returns | |
|---|---|
| Type | Description | 
| Google\Cloud\Iam\V1\Policy | |
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
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of
permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
The async variant is Google\Cloud\BeyondCorp\ClientConnectorServices\V1\Client\BaseClient\self::testIamPermissionsAsync() .
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\Iam\V1\TestIamPermissionsRequestA request to house fields associated with the call. | 
| callOptions | arrayOptional. | 
| ↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. | 
| Returns | |
|---|---|
| Type | Description | 
| Google\Cloud\Iam\V1\TestIamPermissionsResponse | |
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
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\BeyondCorp\ClientConnectorServices\V1\CreateClientConnectorServiceRequest | 
| optionalArgs = [] | array | 
| Returns | |
|---|---|
| Type | Description | 
| GuzzleHttp\Promise\PromiseInterface | |
deleteClientConnectorServiceAsync
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\BeyondCorp\ClientConnectorServices\V1\DeleteClientConnectorServiceRequest | 
| optionalArgs = [] | array | 
| Returns | |
|---|---|
| Type | Description | 
| GuzzleHttp\Promise\PromiseInterface | |
getClientConnectorServiceAsync
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\BeyondCorp\ClientConnectorServices\V1\GetClientConnectorServiceRequest | 
| optionalArgs = [] | array | 
| Returns | |
|---|---|
| Type | Description | 
| GuzzleHttp\Promise\PromiseInterface | |
listClientConnectorServicesAsync
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\BeyondCorp\ClientConnectorServices\V1\ListClientConnectorServicesRequest | 
| optionalArgs = [] | array | 
| Returns | |
|---|---|
| Type | Description | 
| GuzzleHttp\Promise\PromiseInterface | |
updateClientConnectorServiceAsync
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\BeyondCorp\ClientConnectorServices\V1\UpdateClientConnectorServiceRequest | 
| optionalArgs = [] | array | 
| Returns | |
|---|---|
| Type | Description | 
| GuzzleHttp\Promise\PromiseInterface | |
getLocationAsync
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\Location\GetLocationRequest | 
| optionalArgs = [] | array | 
| Returns | |
|---|---|
| Type | Description | 
| GuzzleHttp\Promise\PromiseInterface | |
listLocationsAsync
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\Location\ListLocationsRequest | 
| optionalArgs = [] | array | 
| Returns | |
|---|---|
| Type | Description | 
| GuzzleHttp\Promise\PromiseInterface | |
getIamPolicyAsync
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\Iam\V1\GetIamPolicyRequest | 
| optionalArgs = [] | array | 
| Returns | |
|---|---|
| Type | Description | 
| GuzzleHttp\Promise\PromiseInterface | |
setIamPolicyAsync
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\Iam\V1\SetIamPolicyRequest | 
| optionalArgs = [] | array | 
| Returns | |
|---|---|
| Type | Description | 
| GuzzleHttp\Promise\PromiseInterface | |
testIamPermissionsAsync
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\Iam\V1\TestIamPermissionsRequest | 
| optionalArgs = [] | array | 
| Returns | |
|---|---|
| Type | Description | 
| GuzzleHttp\Promise\PromiseInterface | |
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
| Returns | |
|---|---|
| Type | Description | 
| Google\ApiCore\LongRunning\OperationsClient | |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
| Parameters | |
|---|---|
| Name | Description | 
| operationName | stringThe name of the long running operation | 
| methodName | stringThe name of the method used to start the operation | 
| Returns | |
|---|---|
| Type | Description | 
| Google\ApiCore\OperationResponse | |
static::clientConnectorServiceName
Formats a string containing the fully-qualified path to represent a client_connector_service resource.
| Parameters | |
|---|---|
| Name | Description | 
| project | string | 
| location | string | 
| clientConnectorService | string | 
| Returns | |
|---|---|
| Type | Description | 
| string | The formatted client_connector_service resource. | 
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
| Parameters | |
|---|---|
| Name | Description | 
| project | string | 
| location | string | 
| Returns | |
|---|---|
| Type | Description | 
| string | The formatted location resource. | 
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- clientConnectorService: projects/{project}/locations/{location}/clientConnectorServices/{client_connector_service}
- location: projects/{project}/locations/{location}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
| Parameters | |
|---|---|
| Name | Description | 
| formattedName | stringThe formatted name string | 
| template | stringOptional name of template to match | 
| Returns | |
|---|---|
| Type | Description | 
| array | An associative array from name component IDs to component values. |