Google Cloud Functions V2 Client - Class FunctionServiceClient (1.7.0)

Reference documentation and code samples for the Google Cloud Functions V2 Client class FunctionServiceClient.

Service Description: Google Cloud Functions is used to deploy functions that are executed by Google in response to various events. Data connected with that event is passed to a function as the input data.

A function is a resource which describes a function that should be executed and how it is triggered.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Cloud \ Functions \ V2 \ 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.

createFunction

Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return ALREADY_EXISTS error.

The async variant is Google\Cloud\Functions\V2\Client\FunctionServiceClient::createFunctionAsync() .

Parameters
Name Description
request Google\Cloud\Functions\V2\CreateFunctionRequest

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\Functions\V2\Client\FunctionServiceClient;
use Google\Cloud\Functions\V2\CreateFunctionRequest;
use Google\Cloud\Functions\V2\PBFunction;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The project and location in which the function should be created,
 *                                specified in the format `projects/*/locations/*`
 *                                Please see {@see FunctionServiceClient::locationName()} for help formatting this field.
 */
function create_function_sample(string $formattedParent): void
{
    // Create a client.
    $functionServiceClient = new FunctionServiceClient();

    // Prepare the request message.
    $function = new PBFunction();
    $request = (new CreateFunctionRequest())
        ->setParent($formattedParent)
        ->setFunction($function);

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

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

    create_function_sample($formattedParent);
}

deleteFunction

Deletes a function with the given name from the specified project. If the given function is used by some trigger, the trigger will be updated to remove this function.

The async variant is Google\Cloud\Functions\V2\Client\FunctionServiceClient::deleteFunctionAsync() .

Parameters
Name Description
request Google\Cloud\Functions\V2\DeleteFunctionRequest

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\Functions\V2\Client\FunctionServiceClient;
use Google\Cloud\Functions\V2\DeleteFunctionRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the function which should be deleted. Please see
 *                              {@see FunctionServiceClient::functionName()} for help formatting this field.
 */
function delete_function_sample(string $formattedName): void
{
    // Create a client.
    $functionServiceClient = new FunctionServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $functionServiceClient->deleteFunction($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 = FunctionServiceClient::functionName('[PROJECT]', '[LOCATION]', '[FUNCTION]');

    delete_function_sample($formattedName);
}

generateDownloadUrl

Returns a signed URL for downloading deployed function source code.

The URL is only valid for a limited period and should be used within 30 minutes of generation. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls

The async variant is Google\Cloud\Functions\V2\Client\FunctionServiceClient::generateDownloadUrlAsync() .

Parameters
Name Description
request Google\Cloud\Functions\V2\GenerateDownloadUrlRequest

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\Functions\V2\GenerateDownloadUrlResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Functions\V2\Client\FunctionServiceClient;
use Google\Cloud\Functions\V2\GenerateDownloadUrlRequest;
use Google\Cloud\Functions\V2\GenerateDownloadUrlResponse;

/**
 * @param string $formattedName The name of function for which source code Google Cloud Storage
 *                              signed URL should be generated. Please see
 *                              {@see FunctionServiceClient::functionName()} for help formatting this field.
 */
function generate_download_url_sample(string $formattedName): void
{
    // Create a client.
    $functionServiceClient = new FunctionServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var GenerateDownloadUrlResponse $response */
        $response = $functionServiceClient->generateDownloadUrl($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 = FunctionServiceClient::functionName('[PROJECT]', '[LOCATION]', '[FUNCTION]');

    generate_download_url_sample($formattedName);
}

generateUploadUrl

Returns a signed URL for uploading a function source code.

For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls. Once the function source code upload is complete, the used signed URL should be provided in CreateFunction or UpdateFunction request as a reference to the function source code.

When uploading source code to the generated signed URL, please follow these restrictions:

  • Source file type should be a zip file.
  • No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL.

When making a HTTP PUT request, specify this header:

  • content-type: application/zip

Do not specify this header:

  • Authorization: Bearer YOUR_TOKEN

The async variant is Google\Cloud\Functions\V2\Client\FunctionServiceClient::generateUploadUrlAsync() .

Parameters
Name Description
request Google\Cloud\Functions\V2\GenerateUploadUrlRequest

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\Functions\V2\GenerateUploadUrlResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Functions\V2\Client\FunctionServiceClient;
use Google\Cloud\Functions\V2\GenerateUploadUrlRequest;
use Google\Cloud\Functions\V2\GenerateUploadUrlResponse;

/**
 * @param string $formattedParent The project and location in which the Google Cloud Storage signed
 *                                URL should be generated, specified in the format `projects/*/locations/*`. Please see
 *                                {@see FunctionServiceClient::locationName()} for help formatting this field.
 */
function generate_upload_url_sample(string $formattedParent): void
{
    // Create a client.
    $functionServiceClient = new FunctionServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var GenerateUploadUrlResponse $response */
        $response = $functionServiceClient->generateUploadUrl($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
{
    $formattedParent = FunctionServiceClient::locationName('[PROJECT]', '[LOCATION]');

    generate_upload_url_sample($formattedParent);
}

getFunction

Returns a function with the given name from the requested project.

The async variant is Google\Cloud\Functions\V2\Client\FunctionServiceClient::getFunctionAsync() .

Parameters
Name Description
request Google\Cloud\Functions\V2\GetFunctionRequest

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\Functions\V2\PBFunction
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Functions\V2\Client\FunctionServiceClient;
use Google\Cloud\Functions\V2\GetFunctionRequest;
use Google\Cloud\Functions\V2\PBFunction;

/**
 * @param string $formattedName The name of the function which details should be obtained. Please see
 *                              {@see FunctionServiceClient::functionName()} for help formatting this field.
 */
function get_function_sample(string $formattedName): void
{
    // Create a client.
    $functionServiceClient = new FunctionServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PBFunction $response */
        $response = $functionServiceClient->getFunction($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 = FunctionServiceClient::functionName('[PROJECT]', '[LOCATION]', '[FUNCTION]');

    get_function_sample($formattedName);
}

listFunctions

Returns a list of functions that belong to the requested project.

The async variant is Google\Cloud\Functions\V2\Client\FunctionServiceClient::listFunctionsAsync() .

Parameters
Name Description
request Google\Cloud\Functions\V2\ListFunctionsRequest

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\Functions\V2\Client\FunctionServiceClient;
use Google\Cloud\Functions\V2\ListFunctionsRequest;
use Google\Cloud\Functions\V2\PBFunction;

/**
 * @param string $formattedParent The project and location from which the function should be
 *                                listed, specified in the format `projects/*/locations/*` If you want to
 *                                list functions in all locations, use "-" in place of a location. When
 *                                listing functions in all locations, if one or more location(s) are
 *                                unreachable, the response will contain functions from all reachable
 *                                locations along with the names of any unreachable locations. Please see
 *                                {@see FunctionServiceClient::locationName()} for help formatting this field.
 */
function list_functions_sample(string $formattedParent): void
{
    // Create a client.
    $functionServiceClient = new FunctionServiceClient();

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

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

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

    list_functions_sample($formattedParent);
}

listRuntimes

Returns a list of runtimes that are supported for the requested project.

The async variant is Google\Cloud\Functions\V2\Client\FunctionServiceClient::listRuntimesAsync() .

Parameters
Name Description
request Google\Cloud\Functions\V2\ListRuntimesRequest

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\Functions\V2\ListRuntimesResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Functions\V2\Client\FunctionServiceClient;
use Google\Cloud\Functions\V2\ListRuntimesRequest;
use Google\Cloud\Functions\V2\ListRuntimesResponse;

/**
 * @param string $formattedParent The project and location from which the runtimes should be
 *                                listed, specified in the format `projects/*/locations/*`
 *                                Please see {@see FunctionServiceClient::locationName()} for help formatting this field.
 */
function list_runtimes_sample(string $formattedParent): void
{
    // Create a client.
    $functionServiceClient = new FunctionServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var ListRuntimesResponse $response */
        $response = $functionServiceClient->listRuntimes($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
{
    $formattedParent = FunctionServiceClient::locationName('[PROJECT]', '[LOCATION]');

    list_runtimes_sample($formattedParent);
}

updateFunction

Updates existing function.

The async variant is Google\Cloud\Functions\V2\Client\FunctionServiceClient::updateFunctionAsync() .

Parameters
Name Description
request Google\Cloud\Functions\V2\UpdateFunctionRequest

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\Functions\V2\Client\FunctionServiceClient;
use Google\Cloud\Functions\V2\PBFunction;
use Google\Cloud\Functions\V2\UpdateFunctionRequest;
use Google\Rpc\Status;

/**
 * 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 update_function_sample(): void
{
    // Create a client.
    $functionServiceClient = new FunctionServiceClient();

    // Prepare the request message.
    $function = new PBFunction();
    $request = (new UpdateFunctionRequest())
        ->setFunction($function);

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

        if ($response->operationSucceeded()) {
            /** @var PBFunction $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());
    }
}

listLocations

Lists information about the supported locations for this service.

The async variant is Google\Cloud\Functions\V2\Client\FunctionServiceClient::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\Functions\V2\Client\FunctionServiceClient;
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.
    $functionServiceClient = new FunctionServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $functionServiceClient->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\Functions\V2\Client\FunctionServiceClient::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\Functions\V2\Client\FunctionServiceClient;
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.
    $functionServiceClient = new FunctionServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $functionServiceClient->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\Functions\V2\Client\FunctionServiceClient::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\Functions\V2\Client\FunctionServiceClient;
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.
    $functionServiceClient = new FunctionServiceClient();

    // 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 = $functionServiceClient->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\Functions\V2\Client\FunctionServiceClient::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\Functions\V2\Client\FunctionServiceClient;
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.
    $functionServiceClient = new FunctionServiceClient();

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

createFunctionAsync

Parameters
Name Description
request Google\Cloud\Functions\V2\CreateFunctionRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

deleteFunctionAsync

Parameters
Name Description
request Google\Cloud\Functions\V2\DeleteFunctionRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

generateDownloadUrlAsync

Parameters
Name Description
request Google\Cloud\Functions\V2\GenerateDownloadUrlRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

generateUploadUrlAsync

Parameters
Name Description
request Google\Cloud\Functions\V2\GenerateUploadUrlRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

getFunctionAsync

Parameters
Name Description
request Google\Cloud\Functions\V2\GetFunctionRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

listFunctionsAsync

Parameters
Name Description
request Google\Cloud\Functions\V2\ListFunctionsRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

listRuntimesAsync

Parameters
Name Description
request Google\Cloud\Functions\V2\ListRuntimesRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

updateFunctionAsync

Parameters
Name Description
request Google\Cloud\Functions\V2\UpdateFunctionRequest
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::buildName

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

Parameters
Name Description
project string
location string
build string
Returns
Type Description
string The formatted build resource.

static::channelName

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

Parameters
Name Description
project string
location string
channel string
Returns
Type Description
string The formatted channel resource.

static::connectorName

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

Parameters
Name Description
project string
location string
connector string
Returns
Type Description
string The formatted connector resource.

static::cryptoKeyName

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

Parameters
Name Description
project string
location string
keyRing string
cryptoKey string
Returns
Type Description
string The formatted crypto_key resource.

static::functionName

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

Parameters
Name Description
project string
location string
function string
Returns
Type Description
string The formatted function 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::repositoryName

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

Parameters
Name Description
project string
location string
repository string
Returns
Type Description
string The formatted repository resource.

static::serviceName

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

Parameters
Name Description
project string
location string
service string
Returns
Type Description
string The formatted service resource.

static::topicName

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

Parameters
Name Description
project string
topic string
Returns
Type Description
string The formatted topic resource.

static::triggerName

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

Parameters
Name Description
project string
location string
trigger string
Returns
Type Description
string The formatted trigger resource.

static::workerPoolName

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

Parameters
Name Description
project string
location string
workerPool string
Returns
Type Description
string The formatted worker_pool 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

  • build: projects/{project}/locations/{location}/builds/{build}
  • channel: projects/{project}/locations/{location}/channels/{channel}
  • connector: projects/{project}/locations/{location}/connectors/{connector}
  • cryptoKey: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
  • function: projects/{project}/locations/{location}/functions/{function}
  • location: projects/{project}/locations/{location}
  • repository: projects/{project}/locations/{location}/repositories/{repository}
  • service: projects/{project}/locations/{location}/services/{service}
  • topic: projects/{project}/topics/{topic}
  • trigger: projects/{project}/locations/{location}/triggers/{trigger}
  • workerPool: projects/{project}/locations/{location}/workerPools/{worker_pool}

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.