Cloud Functions v1 API - Class CloudFunctionsService.CloudFunctionsServiceBase (2.2.0)

Version 2.2.0

• 2.7.0 (latest)
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.3.0
• 1.2.0
• 1.1.0

[BindServiceMethod(typeof(CloudFunctionsService), "BindService")]
public abstract class CloudFunctionsService.CloudFunctionsServiceBase

Reference documentation and code samples for the Cloud Functions v1 API class CloudFunctionsService.CloudFunctionsServiceBase.

Base class for server-side implementations of CloudFunctionsService

Inheritance

object > CloudFunctionsService.CloudFunctionsServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Functions.V1

Assembly

Google.Cloud.Functions.V1.dll

Methods

CallFunction(CallFunctionRequest, ServerCallContext)

public virtual Task<CallFunctionResponse> CallFunction(CallFunctionRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	CallFunctionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCallFunctionResponse	The response to send back to the client (wrapped by a task).

CreateFunction(CreateFunctionRequest, ServerCallContext)

public virtual Task<Operation> CreateFunction(CreateFunctionRequest request, ServerCallContext context)

Creates a new function. If a function with the given name already exists in the specified project, the long running operation returns an ALREADY_EXISTS error.

Parameters
Name	Description
request	CreateFunctionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteFunction(DeleteFunctionRequest, ServerCallContext)

public virtual Task<Operation> DeleteFunction(DeleteFunctionRequest request, ServerCallContext context)

Deletes a function with the given name from the specified project. If the given function is used by some trigger, the trigger is updated to remove this function.

Parameters
Name	Description
request	DeleteFunctionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GenerateDownloadUrl(GenerateDownloadUrlRequest, ServerCallContext)

public virtual Task<GenerateDownloadUrlResponse> GenerateDownloadUrl(GenerateDownloadUrlRequest request, ServerCallContext context)

Returns a signed URL for downloading deployed function source code. The URL is only valid for a limited period and must 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	GenerateDownloadUrlRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskGenerateDownloadUrlResponse	The response to send back to the client (wrapped by a task).

GenerateUploadUrl(GenerateUploadUrlRequest, ServerCallContext)

public virtual Task<GenerateUploadUrlResponse> GenerateUploadUrl(GenerateUploadUrlRequest request, ServerCallContext context)

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 an HTTP PUT request, these two headers must be specified:

• content-type: application/zip
• x-goog-content-length-range: 0,104857600

And this header must NOT be specified:

• Authorization: Bearer YOUR_TOKEN

Parameters
Name	Description
request	GenerateUploadUrlRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskGenerateUploadUrlResponse	The response to send back to the client (wrapped by a task).

GetFunction(GetFunctionRequest, ServerCallContext)

public virtual Task<CloudFunction> GetFunction(GetFunctionRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	GetFunctionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCloudFunction	The response to send back to the client (wrapped by a task).

GetIamPolicy(GetIamPolicyRequest, ServerCallContext)

public virtual Task<Policy> GetIamPolicy(GetIamPolicyRequest request, ServerCallContext context)

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	GetIamPolicyRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskPolicy	The response to send back to the client (wrapped by a task).

ListFunctions(ListFunctionsRequest, ServerCallContext)

public virtual Task<ListFunctionsResponse> ListFunctions(ListFunctionsRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListFunctionsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListFunctionsResponse	The response to send back to the client (wrapped by a task).

SetIamPolicy(SetIamPolicyRequest, ServerCallContext)

public virtual Task<Policy> SetIamPolicy(SetIamPolicyRequest request, ServerCallContext context)

Sets the IAM access control policy on the specified function. Replaces any existing policy.

Parameters
Name	Description
request	SetIamPolicyRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskPolicy	The response to send back to the client (wrapped by a task).

TestIamPermissions(TestIamPermissionsRequest, ServerCallContext)

public virtual Task<TestIamPermissionsResponse> TestIamPermissions(TestIamPermissionsRequest request, ServerCallContext context)

Tests the specified permissions against the IAM access control policy for a function. If the function does not exist, this returns an empty set of permissions, not a NOT_FOUND error.

Parameters
Name	Description
request	TestIamPermissionsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTestIamPermissionsResponse	The response to send back to the client (wrapped by a task).

UpdateFunction(UpdateFunctionRequest, ServerCallContext)

public virtual Task<Operation> UpdateFunction(UpdateFunctionRequest request, ServerCallContext context)

Updates existing function.

Parameters
Name	Description
request	UpdateFunctionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).