As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

FunctionService¶

class google.cloud.functions_v2.services.function_service.FunctionServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.functions_v2.services.function_service.transports.base.FunctionServiceTransport, typing.Callable[[...], google.cloud.functions_v2.services.function_service.transports.base.FunctionServiceTransport]]] = 'grpc_asyncio', client_options: typing.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>)[source]¶

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.

Instantiates the function service async client.

Parameters

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 (Optional[Union[str,FunctionServiceTransport,Callable[..., FunctionServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the FunctionServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS 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.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

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

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static build_path(project: str, location: str, build: str) → str¶: Returns a fully-qualified build string.

static channel_path(project: str, location: str, channel: str) → str¶: Returns a fully-qualified channel string.

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

static connector_path(project: str, location: str, connector: str) → str¶: Returns a fully-qualified connector string.

async 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: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

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

request (Optional[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 (google.cloud.functions_v2.types.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_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be 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.

Return type

google.api_core.operation_async.AsyncOperation

static crypto_key_path(project: str, location: str, key_ring: str, crypto_key: str) → str¶: Returns a fully-qualified crypto_key string.

async delete_function(request: Optional[Union[google.cloud.functions_v2.types.functions.DeleteFunctionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

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

request (Optional[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_async.AsyncRetry) – 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

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);

}

Return type

google.api_core.operation_async.AsyncOperation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

FunctionServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

FunctionServiceAsyncClient

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

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

FunctionServiceAsyncClient

static function_path(project: str, location: str, function: str) → str¶: Returns a fully-qualified function string.

async generate_download_url(request: Optional[Union[google.cloud.functions_v2.types.functions.GenerateDownloadUrlRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.functions_v2.types.functions.GenerateDownloadUrlResponse[source]¶

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

request (Optional[Union[google.cloud.functions_v2.types.GenerateDownloadUrlRequest, dict]]) – The request object. Request of GenerateDownloadUrl method.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response of GenerateDownloadUrl method.

Return type

google.cloud.functions_v2.types.GenerateDownloadUrlResponse

async generate_upload_url(request: Optional[Union[google.cloud.functions_v2.types.functions.GenerateUploadUrlRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.functions_v2.types.functions.GenerateUploadUrlResponse[source]¶

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

# 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

request (Optional[Union[google.cloud.functions_v2.types.GenerateUploadUrlRequest, dict]]) – The request object. Request of GenerateSourceUploadUrl method.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response of GenerateSourceUploadUrl method.

Return type

google.cloud.functions_v2.types.GenerateUploadUrlResponse

async get_function(request: Optional[Union[google.cloud.functions_v2.types.functions.GetFunctionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.functions_v2.types.functions.Function[source]¶

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

request (Optional[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_async.AsyncRetry) – 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

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

Return type

google.cloud.functions_v2.types.Function

async get_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.policy_pb2.Policy[source]¶

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

request (GetIamPolicyRequest) – The request object. Request message for GetIamPolicy method.
retry (google.api_core.retry_async.AsyncRetry) – 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

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-01T00: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-01T00:00:00.000Z')

For a description of IAM and its features, see the IAM developer’s guide.

Return type

Policy

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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 variable 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.

Parameters

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.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

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

async get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (GetOperationRequest) – The request object. Request message for GetOperation method.
retry (google.api_core.retry_async.AsyncRetry) – 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

An Operation object.

Return type

Operation

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.functions_v2.services.function_service.transports.base.FunctionServiceTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

async list_functions(request: Optional[Union[google.cloud.functions_v2.types.functions.ListFunctionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.functions_v2.services.function_service.pagers.ListFunctionsAsyncPager[source]¶

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

request (Optional[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_async.AsyncRetry) – 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

Response for the ListFunctions method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.functions_v2.services.function_service.pagers.ListFunctionsAsyncPager

async list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters

request (ListLocationsRequest) – The request object. Request message for ListLocations method.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for ListLocations method.

Return type

ListLocationsResponse

async list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse[source]¶

Lists operations that match the specified filter in the request.

Parameters

request (ListOperationsRequest) – The request object. Request message for ListOperations method.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for ListOperations method.

Return type

ListOperationsResponse

async list_runtimes(request: Optional[Union[google.cloud.functions_v2.types.functions.ListRuntimesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.functions_v2.types.functions.ListRuntimesResponse[source]¶

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

request (Optional[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_async.AsyncRetry) – 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

Response for the ListRuntimes method.

Return type

google.cloud.functions_v2.types.ListRuntimesResponse

static parse_build_path(path: str) → Dict[str, str]¶: Parses a build path into its component segments.

static parse_channel_path(path: str) → Dict[str, str]¶: Parses a channel path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_connector_path(path: str) → Dict[str, str]¶: Parses a connector path into its component segments.

static parse_crypto_key_path(path: str) → Dict[str, str]¶: Parses a crypto_key path into its component segments.

static parse_function_path(path: str) → Dict[str, str]¶: Parses a function path into its component segments.

static parse_repository_path(path: str) → Dict[str, str]¶: Parses a repository path into its component segments.

static parse_service_path(path: str) → Dict[str, str]¶: Parses a service path into its component segments.

static parse_topic_path(path: str) → Dict[str, str]¶: Parses a topic path into its component segments.

static parse_trigger_path(path: str) → Dict[str, str]¶: Parses a trigger path into its component segments.

static parse_worker_pool_path(path: str) → Dict[str, str]¶: Parses a worker_pool path into its component segments.

static repository_path(project: str, location: str, repository: str) → str¶: Returns a fully-qualified repository string.

static service_path(project: str, location: str, service: str) → str¶: Returns a fully-qualified service string.

async set_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.policy_pb2.Policy[source]¶

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

Parameters

request (SetIamPolicyRequest) – The request object. Request message for SetIamPolicy method.
retry (google.api_core.retry_async.AsyncRetry) – 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

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-01T00: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-01T00:00:00.000Z')

For a description of IAM and its features, see the IAM developer’s guide.

Return type

Policy

async test_iam_permissions(request: Optional[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse[source]¶

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

request (TestIamPermissionsRequest) – The request object. Request message for TestIamPermissions method.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for TestIamPermissions method.

Return type

TestIamPermissionsResponse

static topic_path(project: str, topic: str) → str¶: Returns a fully-qualified topic string.

property transport: google.cloud.functions_v2.services.function_service.transports.base.FunctionServiceTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: FunctionServiceTransport

static trigger_path(project: str, location: str, trigger: str) → str¶: Returns a fully-qualified trigger string.

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async 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: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

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

request (Optional[Union[google.cloud.functions_v2.types.UpdateFunctionRequest, dict]]) – The request object. Request for the UpdateFunction method.
function (google.cloud.functions_v2.types.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 fields 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_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be 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.

Return type

google.api_core.operation_async.AsyncOperation

static worker_pool_path(project: str, location: str, worker_pool: str) → str¶: Returns a fully-qualified worker_pool string.

class google.cloud.functions_v2.services.function_service.FunctionServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.functions_v2.services.function_service.transports.base.FunctionServiceTransport, typing.Callable[[...], google.cloud.functions_v2.services.function_service.transports.base.FunctionServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

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.

Instantiates the function service client.

Parameters

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 (Optional[Union[str,FunctionServiceTransport,Callable[..., FunctionServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the FunctionServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS 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.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

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

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static build_path(project: str, location: str, build: str) → str[source]¶: Returns a fully-qualified build string.

static channel_path(project: str, location: str, channel: str) → str[source]¶: Returns a fully-qualified channel string.

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

static connector_path(project: str, location: str, connector: str) → str[source]¶: Returns a fully-qualified connector string.

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

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

def sample_create_function():
    # Create a client
    client = functions_v2.FunctionServiceClient()

    # 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 = operation.result()

    # Handle the response
    print(response)

Parameters

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 (google.cloud.functions_v2.types.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

An object representing a long-running operation.

The result type for the operation will be 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.

Return type

google.api_core.operation.Operation

static crypto_key_path(project: str, location: str, key_ring: str, crypto_key: str) → str[source]¶: Returns a fully-qualified crypto_key string.

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

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

def sample_delete_function():
    # Create a client
    client = functions_v2.FunctionServiceClient()

    # 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 = operation.result()

    # Handle the response
    print(response)

Parameters

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

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);

}

Return type

google.api_core.operation.Operation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

FunctionServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

FunctionServiceClient

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

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

FunctionServiceClient

static function_path(project: str, location: str, function: str) → str[source]¶: Returns a fully-qualified function string.

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

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

def sample_generate_download_url():
    # Create a client
    client = functions_v2.FunctionServiceClient()

    # Initialize request argument(s)
    request = functions_v2.GenerateDownloadUrlRequest(
        name="name_value",
    )

    # Make the request
    response = client.generate_download_url(request=request)

    # Handle the response
    print(response)

Parameters

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

Response of GenerateDownloadUrl method.

Return type

google.cloud.functions_v2.types.GenerateDownloadUrlResponse

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

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

# 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

def sample_generate_upload_url():
    # Create a client
    client = functions_v2.FunctionServiceClient()

    # Initialize request argument(s)
    request = functions_v2.GenerateUploadUrlRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.generate_upload_url(request=request)

    # Handle the response
    print(response)

Parameters

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

Response of GenerateSourceUploadUrl method.

Return type

google.cloud.functions_v2.types.GenerateUploadUrlResponse

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

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

def sample_get_function():
    # Create a client
    client = functions_v2.FunctionServiceClient()

    # Initialize request argument(s)
    request = functions_v2.GetFunctionRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_function(request=request)

    # Handle the response
    print(response)

Parameters

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

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

Return type

google.cloud.functions_v2.types.Function

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

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

request (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

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-01T00: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-01T00:00:00.000Z')

For a description of IAM and its features, see the IAM developer’s guide.

Return type

Policy

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Deprecated. 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 variable 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.

Parameters

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.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

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

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

Gets the latest state of a long-running operation.

Parameters

request (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

An Operation object.

Return type

Operation

list_functions(request: Optional[Union[google.cloud.functions_v2.types.functions.ListFunctionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.functions_v2.services.function_service.pagers.ListFunctionsPager[source]¶

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

def sample_list_functions():
    # Create a client
    client = functions_v2.FunctionServiceClient()

    # Initialize request argument(s)
    request = functions_v2.ListFunctionsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_functions(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

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

Response for the ListFunctions method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.functions_v2.services.function_service.pagers.ListFunctionsPager

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

Lists information about the supported locations for this service.

Parameters

request (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

Response message for ListLocations method.

Return type

ListLocationsResponse

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

Lists operations that match the specified filter in the request.

Parameters

request (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

Response message for ListOperations method.

Return type

ListOperationsResponse

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

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

def sample_list_runtimes():
    # Create a client
    client = functions_v2.FunctionServiceClient()

    # Initialize request argument(s)
    request = functions_v2.ListRuntimesRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.list_runtimes(request=request)

    # Handle the response
    print(response)

Parameters

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

Response for the ListRuntimes method.

Return type

google.cloud.functions_v2.types.ListRuntimesResponse

static parse_build_path(path: str) → Dict[str, str][source]¶: Parses a build path into its component segments.

static parse_channel_path(path: str) → Dict[str, str][source]¶: Parses a channel path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_connector_path(path: str) → Dict[str, str][source]¶: Parses a connector path into its component segments.

static parse_crypto_key_path(path: str) → Dict[str, str][source]¶: Parses a crypto_key path into its component segments.

static parse_function_path(path: str) → Dict[str, str][source]¶: Parses a function path into its component segments.

static parse_repository_path(path: str) → Dict[str, str][source]¶: Parses a repository path into its component segments.

static parse_service_path(path: str) → Dict[str, str][source]¶: Parses a service path into its component segments.

static parse_topic_path(path: str) → Dict[str, str][source]¶: Parses a topic path into its component segments.

static parse_trigger_path(path: str) → Dict[str, str][source]¶: Parses a trigger path into its component segments.

static parse_worker_pool_path(path: str) → Dict[str, str][source]¶: Parses a worker_pool path into its component segments.

static repository_path(project: str, location: str, repository: str) → str[source]¶: Returns a fully-qualified repository string.

static service_path(project: str, location: str, service: str) → str[source]¶: Returns a fully-qualified service string.

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

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

Parameters

request (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

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-01T00: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-01T00:00:00.000Z')

For a description of IAM and its features, see the IAM developer’s guide.

Return type

Policy

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

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

request (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

Response message for TestIamPermissions method.

Return type

TestIamPermissionsResponse

static topic_path(project: str, topic: str) → str[source]¶: Returns a fully-qualified topic string.

property transport: google.cloud.functions_v2.services.function_service.transports.base.FunctionServiceTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

FunctionServiceTransport

static trigger_path(project: str, location: str, trigger: str) → str[source]¶: Returns a fully-qualified trigger string.

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

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

def sample_update_function():
    # Create a client
    client = functions_v2.FunctionServiceClient()

    # Initialize request argument(s)
    request = functions_v2.UpdateFunctionRequest(
    )

    # Make the request
    operation = client.update_function(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.functions_v2.types.UpdateFunctionRequest, dict]) – The request object. Request for the UpdateFunction method.
function (google.cloud.functions_v2.types.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 fields 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

An object representing a long-running operation.

The result type for the operation will be 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.

Return type

google.api_core.operation.Operation

static worker_pool_path(project: str, location: str, worker_pool: str) → str[source]¶: Returns a fully-qualified worker_pool string.

class google.cloud.functions_v2.services.function_service.pagers.ListFunctionsAsyncPager(method: Callable[[...], Awaitable[google.cloud.functions_v2.types.functions.ListFunctionsResponse]], request: google.cloud.functions_v2.types.functions.ListFunctionsRequest, response: google.cloud.functions_v2.types.functions.ListFunctionsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_functions requests.

This class thinly wraps an initial google.cloud.functions_v2.types.ListFunctionsResponse object, and provides an __aiter__ method to iterate through its functions field.

If there are more pages, the __aiter__ method will make additional ListFunctions requests and continue to iterate through the functions field on the corresponding responses.

All the usual google.cloud.functions_v2.types.ListFunctionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.functions_v2.types.ListFunctionsRequest) – The initial request object.
response (google.cloud.functions_v2.types.ListFunctionsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.functions_v2.services.function_service.pagers.ListFunctionsPager(method: Callable[[...], google.cloud.functions_v2.types.functions.ListFunctionsResponse], request: google.cloud.functions_v2.types.functions.ListFunctionsRequest, response: google.cloud.functions_v2.types.functions.ListFunctionsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_functions requests.

This class thinly wraps an initial google.cloud.functions_v2.types.ListFunctionsResponse object, and provides an __iter__ method to iterate through its functions field.

If there are more pages, the __iter__ method will make additional ListFunctions requests and continue to iterate through the functions field on the corresponding responses.

All the usual google.cloud.functions_v2.types.ListFunctionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.functions_v2.types.ListFunctionsRequest) – The initial request object.
response (google.cloud.functions_v2.types.ListFunctionsResponse) – The initial response object.
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.

FunctionService¶

google-cloud-functions

Navigation

Related Topics