Cloud Functions v1 API - Class CloudFunctionsServiceClientImpl (2.1.0)

public sealed class CloudFunctionsServiceClientImpl : CloudFunctionsServiceClient

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

CloudFunctionsService client wrapper implementation, for convenient use.

Inheritance

Object > CloudFunctionsServiceClient > CloudFunctionsServiceClientImpl

Inherited Members

CloudFunctionsServiceClient.DefaultEndpoint

CloudFunctionsServiceClient.DefaultScopes

CloudFunctionsServiceClient.ServiceMetadata

CloudFunctionsServiceClient.CreateAsync(CancellationToken)

CloudFunctionsServiceClient.Create()

CloudFunctionsServiceClient.ShutdownDefaultChannelsAsync()

CloudFunctionsServiceClient.GetFunctionAsync(GetFunctionRequest, CancellationToken)

CloudFunctionsServiceClient.GetFunction(String, CallSettings)

CloudFunctionsServiceClient.GetFunctionAsync(String, CallSettings)

CloudFunctionsServiceClient.GetFunctionAsync(String, CancellationToken)

CloudFunctionsServiceClient.GetFunction(CloudFunctionName, CallSettings)

CloudFunctionsServiceClient.GetFunctionAsync(CloudFunctionName, CallSettings)

CloudFunctionsServiceClient.GetFunctionAsync(CloudFunctionName, CancellationToken)

CloudFunctionsServiceClient.CreateFunctionAsync(CreateFunctionRequest, CancellationToken)

CloudFunctionsServiceClient.PollOnceCreateFunction(String, CallSettings)

CloudFunctionsServiceClient.PollOnceCreateFunctionAsync(String, CallSettings)

CloudFunctionsServiceClient.CreateFunction(String, CloudFunction, CallSettings)

CloudFunctionsServiceClient.CreateFunctionAsync(String, CloudFunction, CallSettings)

CloudFunctionsServiceClient.CreateFunctionAsync(String, CloudFunction, CancellationToken)

CloudFunctionsServiceClient.CreateFunction(LocationName, CloudFunction, CallSettings)

CloudFunctionsServiceClient.CreateFunctionAsync(LocationName, CloudFunction, CallSettings)

CloudFunctionsServiceClient.CreateFunctionAsync(LocationName, CloudFunction, CancellationToken)

CloudFunctionsServiceClient.UpdateFunctionAsync(UpdateFunctionRequest, CancellationToken)

CloudFunctionsServiceClient.PollOnceUpdateFunction(String, CallSettings)

CloudFunctionsServiceClient.PollOnceUpdateFunctionAsync(String, CallSettings)

CloudFunctionsServiceClient.UpdateFunction(CloudFunction, CallSettings)

CloudFunctionsServiceClient.UpdateFunctionAsync(CloudFunction, CallSettings)

CloudFunctionsServiceClient.UpdateFunctionAsync(CloudFunction, CancellationToken)

CloudFunctionsServiceClient.DeleteFunctionAsync(DeleteFunctionRequest, CancellationToken)

CloudFunctionsServiceClient.PollOnceDeleteFunction(String, CallSettings)

CloudFunctionsServiceClient.PollOnceDeleteFunctionAsync(String, CallSettings)

CloudFunctionsServiceClient.DeleteFunction(String, CallSettings)

CloudFunctionsServiceClient.DeleteFunctionAsync(String, CallSettings)

CloudFunctionsServiceClient.DeleteFunctionAsync(String, CancellationToken)

CloudFunctionsServiceClient.DeleteFunction(CloudFunctionName, CallSettings)

CloudFunctionsServiceClient.DeleteFunctionAsync(CloudFunctionName, CallSettings)

CloudFunctionsServiceClient.DeleteFunctionAsync(CloudFunctionName, CancellationToken)

CloudFunctionsServiceClient.CallFunctionAsync(CallFunctionRequest, CancellationToken)

CloudFunctionsServiceClient.CallFunction(String, String, CallSettings)

CloudFunctionsServiceClient.CallFunctionAsync(String, String, CallSettings)

CloudFunctionsServiceClient.CallFunctionAsync(String, String, CancellationToken)

CloudFunctionsServiceClient.CallFunction(CloudFunctionName, String, CallSettings)

CloudFunctionsServiceClient.CallFunctionAsync(CloudFunctionName, String, CallSettings)

CloudFunctionsServiceClient.CallFunctionAsync(CloudFunctionName, String, CancellationToken)

CloudFunctionsServiceClient.GenerateUploadUrlAsync(GenerateUploadUrlRequest, CancellationToken)

CloudFunctionsServiceClient.GenerateDownloadUrlAsync(GenerateDownloadUrlRequest, CancellationToken)

CloudFunctionsServiceClient.SetIamPolicyAsync(SetIamPolicyRequest, CancellationToken)

CloudFunctionsServiceClient.GetIamPolicyAsync(GetIamPolicyRequest, CancellationToken)

CloudFunctionsServiceClient.TestIamPermissionsAsync(TestIamPermissionsRequest, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Functions.V1

Assembly

Google.Cloud.Functions.V1.dll

Remarks

A service that application uses to manipulate triggers and functions.

Constructors

CloudFunctionsServiceClientImpl(CloudFunctionsService.CloudFunctionsServiceClient, CloudFunctionsServiceSettings, ILogger)

public CloudFunctionsServiceClientImpl(CloudFunctionsService.CloudFunctionsServiceClient grpcClient, CloudFunctionsServiceSettings settings, ILogger logger)

Constructs a client wrapper for the CloudFunctionsService service, with the specified gRPC client and settings.

Parameters
Name	Description
`grpcClient`	`CloudFunctionsService.CloudFunctionsServiceClient` The underlying gRPC client.
`settings`	`CloudFunctionsServiceSettings` The base CloudFunctionsServiceSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

CreateFunctionOperationsClient

public override OperationsClient CreateFunctionOperationsClient { get; }

The long-running operations client for CreateFunction.

Property Value
Type	Description
`OperationsClient`

Overrides

CloudFunctionsServiceClient.CreateFunctionOperationsClient

DeleteFunctionOperationsClient

public override OperationsClient DeleteFunctionOperationsClient { get; }

The long-running operations client for DeleteFunction.

Property Value
Type	Description
`OperationsClient`

Overrides

CloudFunctionsServiceClient.DeleteFunctionOperationsClient

GrpcClient

public override CloudFunctionsService.CloudFunctionsServiceClient GrpcClient { get; }

The underlying gRPC CloudFunctionsService client

Property Value
Type	Description
`CloudFunctionsService.CloudFunctionsServiceClient`

Overrides

CloudFunctionsServiceClient.GrpcClient

UpdateFunctionOperationsClient

public override OperationsClient UpdateFunctionOperationsClient { get; }

The long-running operations client for UpdateFunction.

Property Value
Type	Description
`OperationsClient`

Overrides

CloudFunctionsServiceClient.UpdateFunctionOperationsClient

Methods

CallFunction(CallFunctionRequest, CallSettings)

public override CallFunctionResponse CallFunction(CallFunctionRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`CallFunctionResponse`	The RPC response.

Overrides

CloudFunctionsServiceClient.CallFunction(CallFunctionRequest, CallSettings)

CallFunctionAsync(CallFunctionRequest, CallSettings)

public override Task<CallFunctionResponse> CallFunctionAsync(CallFunctionRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<CallFunctionResponse>`	A Task containing the RPC response.

Overrides

CloudFunctionsServiceClient.CallFunctionAsync(CallFunctionRequest, CallSettings)

CreateFunction(CreateFunctionRequest, CallSettings)

public override Operation<CloudFunction, OperationMetadataV1> CreateFunction(CreateFunctionRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<CloudFunction, OperationMetadataV1>`	The RPC response.

Overrides

CloudFunctionsServiceClient.CreateFunction(CreateFunctionRequest, CallSettings)

CreateFunctionAsync(CreateFunctionRequest, CallSettings)

public override async Task<Operation<CloudFunction, OperationMetadataV1>> CreateFunctionAsync(CreateFunctionRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<CloudFunction, OperationMetadataV1>>`	A Task containing the RPC response.

Overrides

CloudFunctionsServiceClient.CreateFunctionAsync(CreateFunctionRequest, CallSettings)

DeleteFunction(DeleteFunctionRequest, CallSettings)

public override Operation<Empty, OperationMetadataV1> DeleteFunction(DeleteFunctionRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Empty, OperationMetadataV1>`	The RPC response.

Overrides

CloudFunctionsServiceClient.DeleteFunction(DeleteFunctionRequest, CallSettings)

DeleteFunctionAsync(DeleteFunctionRequest, CallSettings)

public override async Task<Operation<Empty, OperationMetadataV1>> DeleteFunctionAsync(DeleteFunctionRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Empty, OperationMetadataV1>>`	A Task containing the RPC response.

Overrides

CloudFunctionsServiceClient.DeleteFunctionAsync(DeleteFunctionRequest, CallSettings)

GenerateDownloadUrl(GenerateDownloadUrlRequest, CallSettings)

public override GenerateDownloadUrlResponse GenerateDownloadUrl(GenerateDownloadUrlRequest request, CallSettings callSettings = null)

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`	`GenerateDownloadUrlRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`GenerateDownloadUrlResponse`	The RPC response.

Overrides

CloudFunctionsServiceClient.GenerateDownloadUrl(GenerateDownloadUrlRequest, CallSettings)

GenerateDownloadUrlAsync(GenerateDownloadUrlRequest, CallSettings)

public override Task<GenerateDownloadUrlResponse> GenerateDownloadUrlAsync(GenerateDownloadUrlRequest request, CallSettings callSettings = null)

Parameters
Name	Description
`request`	`GenerateDownloadUrlRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<GenerateDownloadUrlResponse>`	A Task containing the RPC response.

Overrides

CloudFunctionsServiceClient.GenerateDownloadUrlAsync(GenerateDownloadUrlRequest, CallSettings)

GenerateUploadUrl(GenerateUploadUrlRequest, CallSettings)

public override GenerateUploadUrlResponse GenerateUploadUrl(GenerateUploadUrlRequest request, CallSettings callSettings = null)

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`	`GenerateUploadUrlRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`GenerateUploadUrlResponse`	The RPC response.

Overrides

CloudFunctionsServiceClient.GenerateUploadUrl(GenerateUploadUrlRequest, CallSettings)

GenerateUploadUrlAsync(GenerateUploadUrlRequest, CallSettings)

public override Task<GenerateUploadUrlResponse> GenerateUploadUrlAsync(GenerateUploadUrlRequest request, CallSettings callSettings = null)

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`	`GenerateUploadUrlRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<GenerateUploadUrlResponse>`	A Task containing the RPC response.

Overrides

CloudFunctionsServiceClient.GenerateUploadUrlAsync(GenerateUploadUrlRequest, CallSettings)

GetFunction(GetFunctionRequest, CallSettings)

public override CloudFunction GetFunction(GetFunctionRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`GetFunctionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`CloudFunction`	The RPC response.

Overrides

CloudFunctionsServiceClient.GetFunction(GetFunctionRequest, CallSettings)

GetFunctionAsync(GetFunctionRequest, CallSettings)

public override Task<CloudFunction> GetFunctionAsync(GetFunctionRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`GetFunctionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<CloudFunction>`	A Task containing the RPC response.

Overrides

CloudFunctionsServiceClient.GetFunctionAsync(GetFunctionRequest, CallSettings)

GetIamPolicy(GetIamPolicyRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Policy`	The RPC response.

Overrides

CloudFunctionsServiceClient.GetIamPolicy(GetIamPolicyRequest, CallSettings)

GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Policy>`	A Task containing the RPC response.

Overrides

CloudFunctionsServiceClient.GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

ListFunctions(ListFunctionsRequest, CallSettings)

public override PagedEnumerable<ListFunctionsResponse, CloudFunction> ListFunctions(ListFunctionsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`ListFunctionsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<ListFunctionsResponse, CloudFunction>`	A pageable sequence of CloudFunction resources.

Overrides

CloudFunctionsServiceClient.ListFunctions(ListFunctionsRequest, CallSettings)

ListFunctionsAsync(ListFunctionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListFunctionsResponse, CloudFunction> ListFunctionsAsync(ListFunctionsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`ListFunctionsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<ListFunctionsResponse, CloudFunction>`	A pageable asynchronous sequence of CloudFunction resources.

Overrides

CloudFunctionsServiceClient.ListFunctionsAsync(ListFunctionsRequest, CallSettings)

SetIamPolicy(SetIamPolicyRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`SetIamPolicyRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Policy`	The RPC response.

Overrides

CloudFunctionsServiceClient.SetIamPolicy(SetIamPolicyRequest, CallSettings)

SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`SetIamPolicyRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Policy>`	A Task containing the RPC response.

Overrides

CloudFunctionsServiceClient.SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

TestIamPermissions(TestIamPermissionsRequest, CallSettings)

public override TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)

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`	`TestIamPermissionsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TestIamPermissionsResponse`	The RPC response.

Overrides

CloudFunctionsServiceClient.TestIamPermissions(TestIamPermissionsRequest, CallSettings)

TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

public override Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)

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`	`TestIamPermissionsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<TestIamPermissionsResponse>`	A Task containing the RPC response.

Overrides

CloudFunctionsServiceClient.TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

UpdateFunction(UpdateFunctionRequest, CallSettings)

public override Operation<CloudFunction, OperationMetadataV1> UpdateFunction(UpdateFunctionRequest request, CallSettings callSettings = null)

Updates existing function.

Parameters
Name	Description
`request`	`UpdateFunctionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<CloudFunction, OperationMetadataV1>`	The RPC response.

Overrides

CloudFunctionsServiceClient.UpdateFunction(UpdateFunctionRequest, CallSettings)

UpdateFunctionAsync(UpdateFunctionRequest, CallSettings)

public override async Task<Operation<CloudFunction, OperationMetadataV1>> UpdateFunctionAsync(UpdateFunctionRequest request, CallSettings callSettings = null)

Updates existing function.

Parameters
Name	Description
`request`	`UpdateFunctionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<CloudFunction, OperationMetadataV1>>`	A Task containing the RPC response.

Overrides

CloudFunctionsServiceClient.UpdateFunctionAsync(UpdateFunctionRequest, CallSettings)