Cloud Functions v2 API - Class FunctionService.FunctionServiceBase (1.2.0)

Version 1.2.0

• 1.7.0 (latest)
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

[BindServiceMethod(typeof(FunctionService), "BindService")]
public abstract class FunctionService.FunctionServiceBase

Reference documentation and code samples for the Cloud Functions v2 API class FunctionService.FunctionServiceBase.

Base class for server-side implementations of FunctionService

Inheritance

object > FunctionService.FunctionServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

GoogleCloudGoogle.Cloud.FunctionsV2

Assembly

Google.Cloud.Functions.V2.dll

Methods

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 will return 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 will be 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 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

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.
• No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL.

When making a HTTP PUT request, these two headers need to be specified:

• content-type: application/zip

And this header SHOULD NOT be specified:

• Authorization: Bearer YOUR_TOKEN

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<Function> 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
TaskFunction	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).

ListRuntimes(ListRuntimesRequest, ServerCallContext)

public virtual Task<ListRuntimesResponse> ListRuntimes(ListRuntimesRequest request, ServerCallContext context)

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

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

Returns
Type	Description
TaskListRuntimesResponse	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).