* $cloudfunctionsService = new Google\Service\CloudFunctions(...); * $functions = $cloudfunctionsService->projects_locations_functions; * */ class ProjectsLocationsFunctions extends \Google\Service\Resource { /** * 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. (functions.create) * * @param string $parent Required. The project and location in which the * function should be created, specified in the format `projects/locations` * @param CloudfunctionsFunction $postBody * @param array $optParams Optional parameters. * * @opt_param string functionId The ID to use for the function, which will * become the final component of the function's resource name. This value should * be 4-63 characters, and valid characters are /a-z-/. * @return Operation */ public function create($parent, CloudfunctionsFunction $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], Operation::class); } /** * 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. (functions.delete) * * @param string $name Required. The name of the function which should be * deleted. * @param array $optParams Optional parameters. * @return Operation */ public function delete($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('delete', [$params], Operation::class); } /** * 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 * (functions.generateDownloadUrl) * * @param string $name Required. The name of function for which source code * Google Cloud Storage signed URL should be generated. * @param GenerateDownloadUrlRequest $postBody * @param array $optParams Optional parameters. * @return GenerateDownloadUrlResponse */ public function generateDownloadUrl($name, GenerateDownloadUrlRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('generateDownloadUrl', [$params], GenerateDownloadUrlResponse::class); } /** * 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` (functions.generateUploadUrl) * * @param string $parent Required. The project and location in which the Google * Cloud Storage signed URL should be generated, specified in the format * `projects/locations`. * @param GenerateUploadUrlRequest $postBody * @param array $optParams Optional parameters. * @return GenerateUploadUrlResponse */ public function generateUploadUrl($parent, GenerateUploadUrlRequest $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('generateUploadUrl', [$params], GenerateUploadUrlResponse::class); } /** * Returns a function with the given name from the requested project. * (functions.get) * * @param string $name Required. The name of the function which details should * be obtained. * @param array $optParams Optional parameters. * @return CloudfunctionsFunction */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], CloudfunctionsFunction::class); } /** * Gets the access control policy for a resource. Returns an empty policy if the * resource exists and does not have a policy set. (functions.getIamPolicy) * * @param string $resource REQUIRED: The resource for which the policy is being * requested. See [Resource * names](https://cloud.google.com/apis/design/resource_names) for the * appropriate value for this field. * @param array $optParams Optional parameters. * * @opt_param int options.requestedPolicyVersion Optional. The maximum policy * version that will be used to format the policy. Valid values are 0, 1, and 3. * Requests specifying an invalid value will be rejected. Requests for policies * with any conditional role bindings must specify version 3. Policies with no * conditional role bindings may specify any valid value or leave the field * unset. The policy in the response might use the policy version that you * specified, or it might use a lower policy version. For example, if you * specify version 3, but the policy has no conditional role bindings, the * response uses version 1. To learn which resources support conditions in their * IAM policies, see the [IAM * documentation](https://cloud.google.com/iam/help/conditions/resource- * policies). * @return Policy */ public function getIamPolicy($resource, $optParams = []) { $params = ['resource' => $resource]; $params = array_merge($params, $optParams); return $this->call('getIamPolicy', [$params], Policy::class); } /** * Returns a list of functions that belong to the requested project. * (functions.listProjectsLocationsFunctions) * * @param string $parent Required. 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. * @param array $optParams Optional parameters. * * @opt_param string filter The filter for Functions that match the filter * expression, following the syntax outlined in https://google.aip.dev/160. * @opt_param string orderBy The sorting order of the resources returned. Value * should be a comma separated list of fields. The default sorting oder is * ascending. See https://google.aip.dev/132#ordering. * @opt_param int pageSize Maximum number of functions to return per call. The * largest allowed page_size is 1,000, if the page_size is omitted or specified * as greater than 1,000 then it will be replaced as 1,000. The size of the list * response can be less than specified when used with filters. * @opt_param string pageToken The value returned by the last * `ListFunctionsResponse`; indicates that this is a continuation of a prior * `ListFunctions` call, and that the system should return the next page of * data. * @return ListFunctionsResponse */ public function listProjectsLocationsFunctions($parent, $optParams = []) { $params = ['parent' => $parent]; $params = array_merge($params, $optParams); return $this->call('list', [$params], ListFunctionsResponse::class); } /** * Updates existing function. (functions.patch) * * @param string $name A user-defined name of the function. Function names must * be unique globally and match pattern `projects/locations/functions` * @param CloudfunctionsFunction $postBody * @param array $optParams Optional parameters. * * @opt_param string updateMask The list of fields to be updated. If no field * mask is provided, all provided fields in the request will be updated. * @return Operation */ public function patch($name, CloudfunctionsFunction $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('patch', [$params], Operation::class); } /** * Sets the access control policy on the specified resource. Replaces any * existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and * `PERMISSION_DENIED` errors. (functions.setIamPolicy) * * @param string $resource REQUIRED: The resource for which the policy is being * specified. See [Resource * names](https://cloud.google.com/apis/design/resource_names) for the * appropriate value for this field. * @param SetIamPolicyRequest $postBody * @param array $optParams Optional parameters. * @return Policy */ public function setIamPolicy($resource, SetIamPolicyRequest $postBody, $optParams = []) { $params = ['resource' => $resource, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('setIamPolicy', [$params], Policy::class); } /** * 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. * (functions.testIamPermissions) * * @param string $resource REQUIRED: The resource for which the policy detail is * being requested. See [Resource * names](https://cloud.google.com/apis/design/resource_names) for the * appropriate value for this field. * @param TestIamPermissionsRequest $postBody * @param array $optParams Optional parameters. * @return TestIamPermissionsResponse */ public function testIamPermissions($resource, TestIamPermissionsRequest $postBody, $optParams = []) { $params = ['resource' => $resource, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('testIamPermissions', [$params], TestIamPermissionsResponse::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(ProjectsLocationsFunctions::class, 'Google_Service_CloudFunctions_Resource_ProjectsLocationsFunctions');