# -*- coding: utf-8 -*- # # Copyright 2021 Google LLC. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Cloud Functions (2nd gen) API Client.""" from __future__ import absolute_import from __future__ import division from __future__ import unicode_literals from typing import Generator, Optional from apitools.base.py import exceptions as apitools_exceptions from apitools.base.py import list_pager from googlecloudsdk.api_lib.functions.v1 import util as util_v1 from googlecloudsdk.api_lib.functions.v2 import types from googlecloudsdk.api_lib.functions.v2 import util from googlecloudsdk.core import properties import six class FunctionsClient(object): """Client for Cloud Functions (2nd gen) API.""" def __init__(self, release_track): self.client = util.GetClientInstance(release_track) self.messages = util.GetMessagesModule(release_track) def ListRegions(self) -> Generator[types.Location, None, None]: """Lists GCF gen2 regions. Returns: Iterable[cloudfunctions_v2alpha.Location], Generator of available GCF gen2 regions. """ project = properties.VALUES.core.project.GetOrFail() request = self.messages.CloudfunctionsProjectsLocationsListRequest( name='projects/' + project ) return list_pager.YieldFromList( service=self.client.projects_locations, request=request, field='locations', batch_size_attribute='pageSize', ) def ListRuntimes(self, region: str, query_filter: Optional[str] = None): """Lists available GCF Gen 2 Runtimes in a region. Args: region: str, The region targeted to list runtimes in. query_filter: str, Filters to apply to the list runtimes request. Returns: v2alpha|v2beta.ListRuntimesResponse, The list runtimes request """ project = properties.VALUES.core.project.GetOrFail() # v2alpha|v2beta.CloudfunctionsProjectsLocationsRuntimesListRequest request = self.messages.CloudfunctionsProjectsLocationsRuntimesListRequest( parent='projects/{project}/locations/{region}'.format( project=project, region=region ), filter=query_filter, ) return self.client.projects_locations_runtimes.List(request) @util_v1.CatchHTTPErrorRaiseHTTPException def GetFunction( self, name: str, raise_if_not_found: bool = False ) -> Optional[types.Function]: """Gets the function with the given name or None if not found. Args: name: GCFv2 function resource relative name. raise_if_not_found: If set, raises NOT_FOUND http errors instead of returning None. Returns: cloudfunctions_v2_messages.Function, the fetched GCFv2 function or None. """ try: return self.client.projects_locations_functions.Get( self.messages.CloudfunctionsProjectsLocationsFunctionsGetRequest( name=name ) ) except apitools_exceptions.HttpError as error: if raise_if_not_found or ( error.status_code != six.moves.http_client.NOT_FOUND ): raise return None @util_v1.CatchHTTPErrorRaiseHTTPException def AbortFunctionUpgrade(self, name: str) -> types.Operation: """Aborts the function upgrade for the given function. Args: name: str, GCFv2 function resource relative name. Returns: A long-running operation. """ return self.client.projects_locations_functions.AbortFunctionUpgrade( self.messages.CloudfunctionsProjectsLocationsFunctionsAbortFunctionUpgradeRequest( name=name ) ) @util_v1.CatchHTTPErrorRaiseHTTPException def CommitFunctionUpgrade(self, name: str) -> types.Operation: """Commits the function upgrade for the given function. Args: name: str, GCFv2 function resource relative name. Returns: A long-running operation. """ return self.client.projects_locations_functions.CommitFunctionUpgrade( self.messages.CloudfunctionsProjectsLocationsFunctionsCommitFunctionUpgradeRequest( name=name ) ) @util_v1.CatchHTTPErrorRaiseHTTPException def RedirectFunctionUpgradeTraffic(self, name: str) -> types.Operation: """Redirects function upgrade traffic for the given function. Args: name: str, GCFv2 function resource relative name. Returns: A long-running operation. """ return self.client.projects_locations_functions.RedirectFunctionUpgradeTraffic( self.messages.CloudfunctionsProjectsLocationsFunctionsRedirectFunctionUpgradeTrafficRequest( name=name ) ) @util_v1.CatchHTTPErrorRaiseHTTPException def RollbackFunctionUpgradeTraffic(self, name: str) -> types.Operation: """Rolls back function upgrade traffic for the given function. Args: name: str, GCFv2 function resource relative name. Returns: A long-running operation. """ return self.client.projects_locations_functions.RollbackFunctionUpgradeTraffic( self.messages.CloudfunctionsProjectsLocationsFunctionsRollbackFunctionUpgradeTrafficRequest( name=name ) ) @util_v1.CatchHTTPErrorRaiseHTTPException def SetupFunctionUpgradeConfig( self, name: str, trigger_service_account: str ) -> types.Operation: """Sets up the function upgrade config for the given function. Args: name: str, GCFv2 function resource relative name. trigger_service_account: str, The service account to use for the trigger. Returns: A long-running operation. """ return self.client.projects_locations_functions.SetupFunctionUpgradeConfig( self.messages.CloudfunctionsProjectsLocationsFunctionsSetupFunctionUpgradeConfigRequest( name=name, setupFunctionUpgradeConfigRequest=self.messages.SetupFunctionUpgradeConfigRequest( triggerServiceAccount=trigger_service_account ), ) ) @util_v1.CatchHTTPErrorRaiseHTTPException def DetachFunction(self, name: str) -> types.Operation: """Detach a GCF 2nd gen function from GCF and make it a native Cloud Run function. Args: name: str, GCFv2 function resource relative name which follows the format of `projects/{project}/locations/{region}/functions/{function}`. Returns: A long-running operation. """ return self.client.projects_locations_functions.DetachFunction( self.messages.CloudfunctionsProjectsLocationsFunctionsDetachFunctionRequest( name=name ) )