Google Cloud BeyondCorp AppConnectors V1 Client - Class AppConnectorsServiceClient (0.2.2)

Reference documentation and code samples for the Google Cloud BeyondCorp AppConnectors V1 Client class AppConnectorsServiceClient.

Service Description: API Overview:

This class is currently experimental and may be subject to changes.

Namespace

Google \ Cloud \ BeyondCorp \ AppConnectors \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The 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`	`array` Options 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`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client 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\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration 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`	`callable` A 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.

createAppConnector

Creates a new AppConnector in a given project and location.

The async variant is Google\Cloud\BeyondCorp\AppConnectors\V1\Client\BaseClient\self::createAppConnectorAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BeyondCorp\AppConnectors\V1\CreateAppConnectorRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\BeyondCorp\AppConnectors\V1\AppConnector;
use Google\Cloud\BeyondCorp\AppConnectors\V1\AppConnector\PrincipalInfo;
use Google\Cloud\BeyondCorp\AppConnectors\V1\Client\AppConnectorsServiceClient;
use Google\Cloud\BeyondCorp\AppConnectors\V1\CreateAppConnectorRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedParent  The resource project name of the AppConnector location using the
 *                                 form: `projects/{project_id}/locations/{location_id}`
 *                                 Please see {@see AppConnectorsServiceClient::locationName()} for help formatting this field.
 * @param string $appConnectorName Unique resource name of the AppConnector.
 *                                 The name is ignored when creating a AppConnector.
 */
function create_app_connector_sample(string $formattedParent, string $appConnectorName): void
{
    // Create a client.
    $appConnectorsServiceClient = new AppConnectorsServiceClient();

    // Prepare the request message.
    $appConnectorPrincipalInfo = new PrincipalInfo();
    $appConnector = (new AppConnector())
        ->setName($appConnectorName)
        ->setPrincipalInfo($appConnectorPrincipalInfo);
    $request = (new CreateAppConnectorRequest())
        ->setParent($formattedParent)
        ->setAppConnector($appConnector);

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

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

    create_app_connector_sample($formattedParent, $appConnectorName);
}

deleteAppConnector

Deletes a single AppConnector.

The async variant is Google\Cloud\BeyondCorp\AppConnectors\V1\Client\BaseClient\self::deleteAppConnectorAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BeyondCorp\AppConnectors\V1\DeleteAppConnectorRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\BeyondCorp\AppConnectors\V1\Client\AppConnectorsServiceClient;
use Google\Cloud\BeyondCorp\AppConnectors\V1\DeleteAppConnectorRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName BeyondCorp AppConnector name using the form:
 *                              `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}`
 *                              Please see {@see AppConnectorsServiceClient::appConnectorName()} for help formatting this field.
 */
function delete_app_connector_sample(string $formattedName): void
{
    // Create a client.
    $appConnectorsServiceClient = new AppConnectorsServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $appConnectorsServiceClient->deleteAppConnector($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 = AppConnectorsServiceClient::appConnectorName(
        '[PROJECT]',
        '[LOCATION]',
        '[APP_CONNECTOR]'
    );

    delete_app_connector_sample($formattedName);
}

getAppConnector

Gets details of a single AppConnector.

The async variant is Google\Cloud\BeyondCorp\AppConnectors\V1\Client\BaseClient\self::getAppConnectorAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BeyondCorp\AppConnectors\V1\GetAppConnectorRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry 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\AppConnectors\V1\AppConnector`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BeyondCorp\AppConnectors\V1\AppConnector;
use Google\Cloud\BeyondCorp\AppConnectors\V1\Client\AppConnectorsServiceClient;
use Google\Cloud\BeyondCorp\AppConnectors\V1\GetAppConnectorRequest;

/**
 * @param string $formattedName BeyondCorp AppConnector name using the form:
 *                              `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}`
 *                              Please see {@see AppConnectorsServiceClient::appConnectorName()} for help formatting this field.
 */
function get_app_connector_sample(string $formattedName): void
{
    // Create a client.
    $appConnectorsServiceClient = new AppConnectorsServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var AppConnector $response */
        $response = $appConnectorsServiceClient->getAppConnector($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 = AppConnectorsServiceClient::appConnectorName(
        '[PROJECT]',
        '[LOCATION]',
        '[APP_CONNECTOR]'
    );

    get_app_connector_sample($formattedName);
}

listAppConnectors

Lists AppConnectors in a given project and location.

The async variant is Google\Cloud\BeyondCorp\AppConnectors\V1\Client\BaseClient\self::listAppConnectorsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BeyondCorp\AppConnectors\V1\ListAppConnectorsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\BeyondCorp\AppConnectors\V1\AppConnector;
use Google\Cloud\BeyondCorp\AppConnectors\V1\Client\AppConnectorsServiceClient;
use Google\Cloud\BeyondCorp\AppConnectors\V1\ListAppConnectorsRequest;

/**
 * @param string $formattedParent The resource name of the AppConnector location using the form:
 *                                `projects/{project_id}/locations/{location_id}`
 *                                Please see {@see AppConnectorsServiceClient::locationName()} for help formatting this field.
 */
function list_app_connectors_sample(string $formattedParent): void
{
    // Create a client.
    $appConnectorsServiceClient = new AppConnectorsServiceClient();

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

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

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

    list_app_connectors_sample($formattedParent);
}

reportStatus

Report status for a given connector.

The async variant is Google\Cloud\BeyondCorp\AppConnectors\V1\Client\BaseClient\self::reportStatusAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BeyondCorp\AppConnectors\V1\ReportStatusRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\BeyondCorp\AppConnectors\V1\AppConnector;
use Google\Cloud\BeyondCorp\AppConnectors\V1\Client\AppConnectorsServiceClient;
use Google\Cloud\BeyondCorp\AppConnectors\V1\ReportStatusRequest;
use Google\Cloud\BeyondCorp\AppConnectors\V1\ResourceInfo;
use Google\Rpc\Status;

/**
 * @param string $formattedAppConnector BeyondCorp Connector name using the form:
 *                                      `projects/{project_id}/locations/{location_id}/connectors/{connector}`
 *                                      Please see {@see AppConnectorsServiceClient::appConnectorName()} for help formatting this field.
 * @param string $resourceInfoId        Unique Id for the resource.
 */
function report_status_sample(string $formattedAppConnector, string $resourceInfoId): void
{
    // Create a client.
    $appConnectorsServiceClient = new AppConnectorsServiceClient();

    // Prepare the request message.
    $resourceInfo = (new ResourceInfo())
        ->setId($resourceInfoId);
    $request = (new ReportStatusRequest())
        ->setAppConnector($formattedAppConnector)
        ->setResourceInfo($resourceInfo);

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

        if ($response->operationSucceeded()) {
            /** @var AppConnector $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
{
    $formattedAppConnector = AppConnectorsServiceClient::appConnectorName(
        '[PROJECT]',
        '[LOCATION]',
        '[APP_CONNECTOR]'
    );
    $resourceInfoId = '[ID]';

    report_status_sample($formattedAppConnector, $resourceInfoId);
}

updateAppConnector

Updates the parameters of a single AppConnector.

The async variant is Google\Cloud\BeyondCorp\AppConnectors\V1\Client\BaseClient\self::updateAppConnectorAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BeyondCorp\AppConnectors\V1\UpdateAppConnectorRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\BeyondCorp\AppConnectors\V1\AppConnector;
use Google\Cloud\BeyondCorp\AppConnectors\V1\AppConnector\PrincipalInfo;
use Google\Cloud\BeyondCorp\AppConnectors\V1\Client\AppConnectorsServiceClient;
use Google\Cloud\BeyondCorp\AppConnectors\V1\UpdateAppConnectorRequest;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;

/**
 * @param string $appConnectorName Unique resource name of the AppConnector.
 *                                 The name is ignored when creating a AppConnector.
 */
function update_app_connector_sample(string $appConnectorName): void
{
    // Create a client.
    $appConnectorsServiceClient = new AppConnectorsServiceClient();

    // Prepare the request message.
    $updateMask = new FieldMask();
    $appConnectorPrincipalInfo = new PrincipalInfo();
    $appConnector = (new AppConnector())
        ->setName($appConnectorName)
        ->setPrincipalInfo($appConnectorPrincipalInfo);
    $request = (new UpdateAppConnectorRequest())
        ->setUpdateMask($updateMask)
        ->setAppConnector($appConnector);

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

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

    update_app_connector_sample($appConnectorName);
}

getLocation

Gets information about a location.

The async variant is Google\Cloud\BeyondCorp\AppConnectors\V1\Client\BaseClient\self::getLocationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry 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`

Example

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

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

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $appConnectorsServiceClient->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\AppConnectors\V1\Client\BaseClient\self::listLocationsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry 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`

Example

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

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $appConnectorsServiceClient->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\AppConnectors\V1\Client\BaseClient\self::getIamPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\GetIamPolicyRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry 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`

Example

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

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

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $appConnectorsServiceClient->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\AppConnectors\V1\Client\BaseClient\self::setIamPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\SetIamPolicyRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry 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`

Example

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

    // 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 = $appConnectorsServiceClient->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\AppConnectors\V1\Client\BaseClient\self::testIamPermissionsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\TestIamPermissionsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry 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`

Example

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

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

createAppConnectorAsync

Parameters
Name	Description
`request`	`Google\Cloud\BeyondCorp\AppConnectors\V1\CreateAppConnectorRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteAppConnectorAsync

Parameters
Name	Description
`request`	`Google\Cloud\BeyondCorp\AppConnectors\V1\DeleteAppConnectorRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getAppConnectorAsync

Parameters
Name	Description
`request`	`Google\Cloud\BeyondCorp\AppConnectors\V1\GetAppConnectorRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listAppConnectorsAsync

Parameters
Name	Description
`request`	`Google\Cloud\BeyondCorp\AppConnectors\V1\ListAppConnectorsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

reportStatusAsync

Parameters
Name	Description
`request`	`Google\Cloud\BeyondCorp\AppConnectors\V1\ReportStatusRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateAppConnectorAsync

Parameters
Name	Description
`request`	`Google\Cloud\BeyondCorp\AppConnectors\V1\UpdateAppConnectorRequest`
`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`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

static::appConnectorName

Formats a string containing the fully-qualified path to represent a app_connector resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`appConnector`	`string`

Returns
Type	Description
`string`	The formatted app_connector 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

appConnector: projects/{project}/locations/{location}/appConnectors/{app_connector}
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`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.