Class FunctionServiceAsyncClient (1.8.3)

FunctionServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.functions_v2.services.function_service.transports.base.FunctionServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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.

Properties

transport

Returns the transport used by the client instance.

Returns

Type Description

FunctionServiceTransport The transport used by the client instance.

Methods

FunctionServiceAsyncClient

FunctionServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.functions_v2.services.function_service.transports.base.FunctionServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the function service client.

Parameters

Name Description

credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

transport Union[str, .FunctionServiceTransport]

The transport to use. If set to None, a transport is chosen automatically.

client_options ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

Exceptions

Type Description

google.auth.exceptions.MutualTlsChannelError If mutual TLS transport creation failed for any reason.

build_path

build_path(project: str, location: str, build: str)

Returns a fully-qualified build string.

channel_path

channel_path(project: str, location: str, channel: str)

Returns a fully-qualified channel string.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

connector_path

connector_path(project: str, location: str, connector: str)

Returns a fully-qualified connector string.

create_function

create_function(request: Optional[Union[google.cloud.functions_v2.types.functions.CreateFunctionRequest, dict]] = None, *, parent: Optional[str] = None, function: Optional[google.cloud.functions_v2.types.functions.Function] = None, function_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

# This snippet 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 as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import functions_v2
async def sample_create_function():
 # Create a client
 client = functions_v2.FunctionServiceAsyncClient()
 # Initialize request argument(s)
 request = functions_v2.CreateFunctionRequest(
 parent="parent_value",
 )
 # Make the request
 operation = client.create_function(request=request)
 print("Waiting for operation to complete...")
 response = await operation.result()
 # Handle the response
 print(response)

Parameters

Name Description

request Union[google.cloud.functions_v2.types.CreateFunctionRequest, dict]

The request object. Request for the CreateFunction method.

parent str

Required. The project and location in which the function should be created, specified in the format projects//locations/ This corresponds to the parent field on the request instance; if request is provided, this should not be set.

function Function

Required. Function to be created. This corresponds to the function field on the request instance; if request is provided, this should not be set.

function_id str

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][0-9]-/. This corresponds to the function_id field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns

Type Description

google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be Function Describes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.

delete_function

delete_function(request: Optional[Union[google.cloud.functions_v2.types.functions.DeleteFunctionRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

# This snippet 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 as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import functions_v2
async def sample_delete_function():
 # Create a client
 client = functions_v2.FunctionServiceAsyncClient()
 # Initialize request argument(s)
 request = functions_v2.DeleteFunctionRequest(
 name="name_value",
 )
 # Make the request
 operation = client.delete_function(request=request)
 print("Waiting for operation to complete...")
 response = await operation.result()
 # Handle the response
 print(response)

Parameters

Name Description

request Union[google.cloud.functions_v2.types.DeleteFunctionRequest, dict]

The request object. Request for the DeleteFunction method.

name str

Required. The name of the function which should be deleted. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns

Type Description

google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name Description

filename str

The path to the service account private key json file.

Returns

Type Description

FunctionServiceAsyncClient The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter

Name Description

info dict

The service account private key info.

Returns

Type Description

FunctionServiceAsyncClient The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name Description

filename str

The path to the service account private key json file.

Returns

Type Description

FunctionServiceAsyncClient The constructed client.

function_path

function_path(project: str, location: str, function: str)

Returns a fully-qualified function string.

generate_download_url

generate_download_url(request: Optional[Union[google.cloud.functions_v2.types.functions.GenerateDownloadUrlRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

# This snippet 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 as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import functions_v2
async def sample_generate_download_url():
 # Create a client
 client = functions_v2.FunctionServiceAsyncClient()
 # Initialize request argument(s)
 request = functions_v2.GenerateDownloadUrlRequest(
 name="name_value",
 )
 # Make the request
 response = await client.generate_download_url(request=request)
 # Handle the response
 print(response)

Parameters

Name Description

request Union[google.cloud.functions_v2.types.GenerateDownloadUrlRequest, dict]

The request object. Request of GenerateDownloadUrl method.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns

Type Description

google.cloud.functions_v2.types.GenerateDownloadUrlResponse Response of GenerateDownloadUrl method.

generate_upload_url

generate_upload_url(request: Optional[Union[google.cloud.functions_v2.types.functions.GenerateUploadUrlRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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, these two headers need to be specified:

content-type: application/zip

And this header SHOULD NOT be specified:

Authorization: Bearer YOUR_TOKEN

# This snippet 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 as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import functions_v2
async def sample_generate_upload_url():
 # Create a client
 client = functions_v2.FunctionServiceAsyncClient()
 # Initialize request argument(s)
 request = functions_v2.GenerateUploadUrlRequest(
 parent="parent_value",
 )
 # Make the request
 response = await client.generate_upload_url(request=request)
 # Handle the response
 print(response)

Parameters

Name Description

request Union[google.cloud.functions_v2.types.GenerateUploadUrlRequest, dict]

The request object. Request of GenerateSourceUploadUrl method.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns

Type Description

google.cloud.functions_v2.types.GenerateUploadUrlResponse Response of GenerateSourceUploadUrl method.

get_function

get_function(request: Optional[Union[google.cloud.functions_v2.types.functions.GetFunctionRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

# This snippet 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 as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import functions_v2
async def sample_get_function():
 # Create a client
 client = functions_v2.FunctionServiceAsyncClient()
 # Initialize request argument(s)
 request = functions_v2.GetFunctionRequest(
 name="name_value",
 )
 # Make the request
 response = await client.get_function(request=request)
 # Handle the response
 print(response)

Parameters

Name Description

request Union[google.cloud.functions_v2.types.GetFunctionRequest, dict]

The request object. Request for the GetFunction method.

name str

Required. The name of the function which details should be obtained. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns

Type Description

google.cloud.functions_v2.types.Function Describes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.

get_iam_policy

get_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the IAM access control policy for a function.

Returns an empty policy if the function exists and does not have a policy set.

Parameters

Name Description

request .iam_policy_pb2.GetIamPolicyRequest

The request object. Request message for GetIamPolicy method.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns

Type Description

.policy_pb2.Policy Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020年10月01日t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:mike@example.com="" -="" group:admins@example.com="" -="" domain:google.com="" -="" serviceaccount:my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020年10月01日t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
 client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter

Name Description

client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Exceptions

Type Description

google.auth.exceptions.MutualTLSChannelError If any errors happen.

Returns

Type Description

Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

get_operation

get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the latest state of a long-running operation.

Parameters

Name Description

request .operations_pb2.GetOperationRequest

The request object. Request message for GetOperation method.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns

Type Description

.operations_pb2.Operation An Operation object.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

list_functions

list_functions(request: Optional[Union[google.cloud.functions_v2.types.functions.ListFunctionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

# This snippet 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 as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import functions_v2
async def sample_list_functions():
 # Create a client
 client = functions_v2.FunctionServiceAsyncClient()
 # Initialize request argument(s)
 request = functions_v2.ListFunctionsRequest(
 parent="parent_value",
 )
 # Make the request
 page_result = client.list_functions(request=request)
 # Handle the response
 async for response in page_result:
 print(response)

Parameters

Name Description

request Union[google.cloud.functions_v2.types.ListFunctionsRequest, dict]

The request object. Request for the ListFunctions method.

parent str

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. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns

Type Description

google.cloud.functions_v2.services.function_service.pagers.ListFunctionsAsyncPager Response for the ListFunctions method. Iterating over this object will yield results and resolve additional pages automatically.

list_locations

list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists information about the supported locations for this service.

Parameters

Name Description

request .location_pb2.ListLocationsRequest

The request object. Request message for ListLocations method.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns

Type Description

.location_pb2.ListLocationsResponse Response message for ListLocations method.

list_operations

list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists operations that match the specified filter in the request.

Parameters

Name Description

request .operations_pb2.ListOperationsRequest

The request object. Request message for ListOperations method.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns

Type Description

.operations_pb2.ListOperationsResponse Response message for ListOperations method.

list_runtimes

list_runtimes(request: Optional[Union[google.cloud.functions_v2.types.functions.ListRuntimesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

# This snippet 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 as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import functions_v2
async def sample_list_runtimes():
 # Create a client
 client = functions_v2.FunctionServiceAsyncClient()
 # Initialize request argument(s)
 request = functions_v2.ListRuntimesRequest(
 parent="parent_value",
 )
 # Make the request
 response = await client.list_runtimes(request=request)
 # Handle the response
 print(response)

Parameters

Name Description

request Union[google.cloud.functions_v2.types.ListRuntimesRequest, dict]

The request object. Request for the ListRuntimes method.

parent str

Required. The project and location from which the runtimes should be listed, specified in the format projects//locations/ This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns

Type Description

google.cloud.functions_v2.types.ListRuntimesResponse Response for the ListRuntimes method.

parse_build_path

parse_build_path(path: str)

Parses a build path into its component segments.

parse_channel_path

parse_channel_path(path: str)

Parses a channel path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_connector_path

parse_connector_path(path: str)

Parses a connector path into its component segments.

parse_function_path

parse_function_path(path: str)

Parses a function path into its component segments.

parse_repository_path

parse_repository_path(path: str)

Parses a repository path into its component segments.

parse_service_path

parse_service_path(path: str)

Parses a service path into its component segments.

parse_topic_path

parse_topic_path(path: str)

Parses a topic path into its component segments.

parse_trigger_path

parse_trigger_path(path: str)

Parses a trigger path into its component segments.

parse_worker_pool_path

parse_worker_pool_path(path: str)

Parses a worker_pool path into its component segments.

repository_path

repository_path(project: str, location: str, repository: str)

Returns a fully-qualified repository string.

service_path

service_path(project: str, location: str, service: str)

Returns a fully-qualified service string.

set_iam_policy

set_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

Parameters

Name Description

request .iam_policy_pb2.SetIamPolicyRequest

The request object. Request message for SetIamPolicy method.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns

Type Description

test_iam_permissions

test_iam_permissions(request: Optional[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Tests the specified IAM permissions against the IAM access control policy for a function.

If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Parameters

Name Description

request .iam_policy_pb2.TestIamPermissionsRequest

The request object. Request message for TestIamPermissions method.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns

Type Description

.iam_policy_pb2.TestIamPermissionsResponse Response message for TestIamPermissions method.

topic_path

topic_path(project: str, topic: str)

Returns a fully-qualified topic string.

trigger_path

trigger_path(project: str, location: str, trigger: str)

Returns a fully-qualified trigger string.

update_function

update_function(request: Optional[Union[google.cloud.functions_v2.types.functions.UpdateFunctionRequest, dict]] = None, *, function: Optional[google.cloud.functions_v2.types.functions.Function] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates existing function.

# This snippet 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 as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import functions_v2
async def sample_update_function():
 # Create a client
 client = functions_v2.FunctionServiceAsyncClient()
 # Initialize request argument(s)
 request = functions_v2.UpdateFunctionRequest(
 )
 # Make the request
 operation = client.update_function(request=request)
 print("Waiting for operation to complete...")
 response = await operation.result()
 # Handle the response
 print(response)

Parameters

Name Description

request Union[google.cloud.functions_v2.types.UpdateFunctionRequest, dict]

The request object. Request for the UpdateFunction method.

function Function

Required. New version of the function. This corresponds to the function field on the request instance; if request is provided, this should not be set.

update_mask google.protobuf.field_mask_pb2.FieldMask

The list of fields to be updated. If no field mask is provided, all provided fields in the request will be updated. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns

Type Description

worker_pool_path

worker_pool_path(project: str, location: str, worker_pool: str)

Returns a fully-qualified worker_pool string.

Class FunctionServiceAsyncClient (1.8.3) Stay organized with collections Save and categorize content based on your preferences.

Properties

transport

Methods

FunctionServiceAsyncClient

build_path

channel_path

common_billing_account_path

common_folder_path

common_location_path

common_organization_path

common_project_path

connector_path

create_function

delete_function

from_service_account_file

from_service_account_info

from_service_account_json

function_path

generate_download_url

generate_upload_url

get_function

get_iam_policy

get_mtls_endpoint_and_cert_source

get_operation

get_transport_class

list_functions

list_locations

list_operations

list_runtimes

parse_build_path

parse_channel_path

parse_common_billing_account_path

parse_common_folder_path

parse_common_location_path

parse_common_organization_path

parse_common_project_path

parse_connector_path

parse_function_path

parse_repository_path

parse_service_path

parse_topic_path

parse_trigger_path

parse_worker_pool_path

repository_path

service_path

set_iam_policy

test_iam_permissions

topic_path

trigger_path

update_function

worker_pool_path

Class FunctionServiceAsyncClient (1.8.3)