com.google.cloud.functions.v1

Class CloudFunctionsServiceGrpc.CloudFunctionsServiceFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<CloudFunctionsServiceGrpc.CloudFunctionsServiceFutureStub>

com.google.cloud.functions.v1.CloudFunctionsServiceGrpc.CloudFunctionsServiceFutureStub

Enclosing class:

CloudFunctionsServiceGrpc

public static final class CloudFunctionsServiceGrpc.CloudFunctionsServiceFutureStub
extends io.grpc.stub.AbstractFutureStub<CloudFunctionsServiceGrpc.CloudFunctionsServiceFutureStub>

 A service that application uses to manipulate triggers and functions.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected CloudFunctionsServiceGrpc.CloudFunctionsServiceFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<CallFunctionResponse>	callFunction(CallFunctionRequest request) Synchronously invokes a deployed Cloud Function.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	createFunction(CreateFunctionRequest request) Creates a new function.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	deleteFunction(DeleteFunctionRequest request) Deletes a function with the given name from the specified project.
com.google.common.util.concurrent.ListenableFuture<GenerateDownloadUrlResponse>	generateDownloadUrl(GenerateDownloadUrlRequest request) Returns a signed URL for downloading deployed function source code.
com.google.common.util.concurrent.ListenableFuture<GenerateUploadUrlResponse>	generateUploadUrl(GenerateUploadUrlRequest request) Returns a signed URL for uploading a function source code.
com.google.common.util.concurrent.ListenableFuture<CloudFunction>	getFunction(GetFunctionRequest request) Returns a function with the given name from the requested project.
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy>	getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request) Gets the IAM access control policy for a function.
com.google.common.util.concurrent.ListenableFuture<ListFunctionsResponse>	listFunctions(ListFunctionsRequest request) Returns a list of functions that belong to the requested project.
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy>	setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request) Sets the IAM access control policy on the specified function.
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request) Tests the specified permissions against the IAM access control policy for a function.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	updateFunction(UpdateFunctionRequest request) Updates existing function.

Methods inherited from class io.grpc.stub.AbstractFutureStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected CloudFunctionsServiceGrpc.CloudFunctionsServiceFutureStub build(io.grpc.Channel channel,
                                                                          io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<CloudFunctionsServiceGrpc.CloudFunctionsServiceFutureStub>

listFunctions

public com.google.common.util.concurrent.ListenableFuture<ListFunctionsResponse> listFunctions(ListFunctionsRequest request)

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

getFunction

public com.google.common.util.concurrent.ListenableFuture<CloudFunction> getFunction(GetFunctionRequest request)

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

createFunction

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> createFunction(CreateFunctionRequest request)

 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.
 

updateFunction

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> updateFunction(UpdateFunctionRequest request)

 Updates existing function.
 

deleteFunction

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> deleteFunction(DeleteFunctionRequest request)

 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.
 

callFunction

public com.google.common.util.concurrent.ListenableFuture<CallFunctionResponse> callFunction(CallFunctionRequest request)

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

generateUploadUrl

public com.google.common.util.concurrent.ListenableFuture<GenerateUploadUrlResponse> generateUploadUrl(GenerateUploadUrlRequest request)

 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`
 

generateDownloadUrl

public com.google.common.util.concurrent.ListenableFuture<GenerateDownloadUrlResponse> generateDownloadUrl(GenerateDownloadUrlRequest request)

 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
 

setIamPolicy

public com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy> setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)

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

getIamPolicy

public com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy> getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)

 Gets the IAM access control policy for a function.
 Returns an empty policy if the function exists and does not have a policy
 set.
 

testIamPermissions

public com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.TestIamPermissionsResponse> testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)

 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.