Class CloudFunctionsServiceClient (0.1.0)

CloudFunctionsServiceClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.functions_v1.services.cloud_functions_service.transports.base.CloudFunctionsServiceTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-functions/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None)

A service that application uses to manipulate triggers and functions.

Methods

CloudFunctionsServiceClient

CloudFunctionsServiceClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.functions_v1.services.cloud_functions_service.transports.base.CloudFunctionsServiceTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-functions/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None)

Instantiate the cloud functions 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, .CloudFunctionsServiceTransport]` 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 environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint, this is the default value for the environment variable) and "auto" (auto switch to the default mTLS endpoint if client SSL credentials is present). However, the `api_endpoint` property takes precedence if provided. (2) The `client_cert_source` property is used to provide client SSL credentials for mutual TLS transport. If not provided, the default SSL credentials will be used if present.

Exceptions

Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

call_function

call_function(request: Optional[google.cloud.functions_v1.types.functions.CallFunctionRequest] = None, *, name: Optional[str] = None, data: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Synchronously invokes a deployed Cloud Function. To be used for testing purposes as very limited traffic is allowed. For more information on the actual limits, refer to Rate Limits <https://cloud.google.com/functions/quotas#rate_limits>__.

Parameters

Name	Description
`request`	`.functions.CallFunctionRequest` The request object. Request for the `CallFunction` method.
`name`	`str` Required. The name of the function to be called. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`data`	`str` Required. Input to be passed to the function. This corresponds to the `data` 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
`.functions.CallFunctionResponse`	Response of `CallFunction` method.

cloud_function_path

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

Return a fully-qualified cloud_function string.

create_function

create_function(request: Optional[google.cloud.functions_v1.types.functions.CreateFunctionRequest] = None, *, location: Optional[str] = None, function: Optional[google.cloud.functions_v1.types.functions.CloudFunction] = None, retry: google.api_core.retry.Retry = <_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.

Parameters

Name	Description
`request`	`.functions.CreateFunctionRequest` The request object. Request for the `CreateFunction` method.
`location`	`str` Required. The project and location in which the function should be created, specified in the format `projects//locations/` This corresponds to the `location` field on the `request` instance; if `request` is provided, this should not be set.
`function`	`.functions.CloudFunction` Required. Function to be created. This corresponds to the `function` 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
`.operation.Operation`	An object representing a long-running operation. The result type for the operation will be .functions.CloudFunction : Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations.

delete_function

delete_function(request: Optional[google.cloud.functions_v1.types.functions.DeleteFunctionRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_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.

Parameters

Name	Description
`request`	`.functions.DeleteFunctionRequest` 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

.operation.Operation

An object representing a long-running operation. The result type for the operation will be

.empty.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); } The JSON representation for Empty is empty JSON object {}.

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
`{@api.name}`	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
`{@api.name}`	The constructed client.

generate_download_url

generate_download_url(request: Optional[google.cloud.functions_v1.types.functions.GenerateDownloadUrlRequest] = None, *, retry: google.api_core.retry.Retry = <_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 minutes after generation. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access- control/signed-urls

Parameters

Name	Description
`request`	`.functions.GenerateDownloadUrlRequest` 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
`.functions.GenerateDownloadUrlResponse`	Response of `GenerateDownloadUrl` method.

generate_upload_url

generate_upload_url(request: Optional[google.cloud.functions_v1.types.functions.GenerateUploadUrlRequest] = None, *, retry: google.api_core.retry.Retry = <_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.
Source file size should not exceed 100MB limit.
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
x-goog-content-length-range: 0,104857600

And this header SHOULD NOT be specified:

Authorization: Bearer YOUR_TOKEN

Parameters

Name	Description
`request`	`.functions.GenerateUploadUrlRequest` 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
`.functions.GenerateUploadUrlResponse`	Response of `GenerateSourceUploadUrl` method.

get_function

get_function(request: Optional[google.cloud.functions_v1.types.functions.GetFunctionRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_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.

Parameters

Name	Description
`request`	`.functions.GetFunctionRequest` 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
`.functions.CloudFunction`	Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations.

get_iam_policy

get_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None, *, retry: google.api_core.retry.Retry = <_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.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.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-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 __.

list_functions

list_functions(request: Optional[google.cloud.functions_v1.types.functions.ListFunctionsRequest] = None, *, retry: google.api_core.retry.Retry = <_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.

Parameters

Name	Description
`request`	`.functions.ListFunctionsRequest` The request object. Request for the `ListFunctions` 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
`.pagers.ListFunctionsPager`	Response for the `ListFunctions` method. Iterating over this object will yield results and resolve additional pages automatically.

parse_cloud_function_path

parse_cloud_function_path(path: str)

Parse a cloud_function path into its component segments.

set_iam_policy

set_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None, *, retry: google.api_core.retry.Retry = <_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.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: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Tests the specified 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.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.TestIamPermissionsResponse`	Response message for `TestIamPermissions` method.

update_function

update_function(request: Optional[google.cloud.functions_v1.types.functions.UpdateFunctionRequest] = None, *, function: Optional[google.cloud.functions_v1.types.functions.CloudFunction] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates existing function.

Parameters

Name	Description
`request`	`.functions.UpdateFunctionRequest` The request object. Request for the `UpdateFunction` method.
`function`	`.functions.CloudFunction` 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.
`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
`.operation.Operation`	An object representing a long-running operation. The result type for the operation will be .functions.CloudFunction : Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations.