A service that application uses to manipulate triggers and functions.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
CloudFunctionsServiceClient(CloudFunctionsServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
CloudFunctionsServiceClient const &
|
CloudFunctionsServiceClient(CloudFunctionsServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
CloudFunctionsServiceClient &&
|
CloudFunctionsServiceClient(std::shared_ptr< CloudFunctionsServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< CloudFunctionsServiceConnection >
|
opts |
Options
|
Operators
operator=(CloudFunctionsServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
CloudFunctionsServiceClient const &
|
Returns | |
---|---|
Type | Description |
CloudFunctionsServiceClient & |
operator=(CloudFunctionsServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
CloudFunctionsServiceClient &&
|
Returns | |
---|---|
Type | Description |
CloudFunctionsServiceClient & |
Functions
ListFunctions(google::cloud::functions::v1::ListFunctionsRequest, Options)
Returns a list of functions that belong to the requested project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::functions::v1::ListFunctionsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::functions::v1::CloudFunction > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetFunction(std::string const &, Options)
Returns a function with the given name from the requested project.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the function which details should be obtained. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::functions::v1::CloudFunction > | the result of the RPC. The response message type (google.cloud.functions.v1.CloudFunction) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetFunction(google::cloud::functions::v1::GetFunctionRequest const &, Options)
Returns a function with the given name from the requested project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::functions::v1::GetFunctionRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::functions::v1::CloudFunction > | the result of the RPC. The response message type (google.cloud.functions.v1.CloudFunction) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateFunction(std::string const &, google::cloud::functions::v1::CloudFunction const &, Options)
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 |
location |
std::string const &
Required. The project and location in which the function should be created, specified in the format |
function |
google::cloud::functions::v1::CloudFunction const &
Required. Function to be created. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::functions::v1::CloudFunction > > | A |
CreateFunction(google::cloud::functions::v1::CreateFunctionRequest const &, Options)
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 |
google::cloud::functions::v1::CreateFunctionRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::functions::v1::CloudFunction > > | A |
UpdateFunction(google::cloud::functions::v1::CloudFunction const &, Options)
Updates existing function.
Parameters | |
---|---|
Name | Description |
function |
google::cloud::functions::v1::CloudFunction const &
Required. New version of the function. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::functions::v1::CloudFunction > > | A |
UpdateFunction(google::cloud::functions::v1::UpdateFunctionRequest const &, Options)
Updates existing function.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::functions::v1::UpdateFunctionRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::functions::v1::CloudFunction > > | A |
DeleteFunction(std::string const &, Options)
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 |
name |
std::string const &
Required. The name of the function which should be deleted. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::functions::v1::OperationMetadataV1 > > | A |
DeleteFunction(google::cloud::functions::v1::DeleteFunctionRequest const &, Options)
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 |
google::cloud::functions::v1::DeleteFunctionRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::functions::v1::OperationMetadataV1 > > | A |
CallFunction(std::string const &, std::string const &, Options)
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 |
name |
std::string const &
Required. The name of the function to be called. |
data |
std::string const &
Required. Input to be passed to the function. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::functions::v1::CallFunctionResponse > | the result of the RPC. The response message type (google.cloud.functions.v1.CallFunctionResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CallFunction(google::cloud::functions::v1::CallFunctionRequest const &, Options)
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 |
google::cloud::functions::v1::CallFunctionRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::functions::v1::CallFunctionResponse > | the result of the RPC. The response message type (google.cloud.functions.v1.CallFunctionResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GenerateUploadUrl(google::cloud::functions::v1::GenerateUploadUrlRequest const &, Options)
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 |
google::cloud::functions::v1::GenerateUploadUrlRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::functions::v1::GenerateUploadUrlResponse > | the result of the RPC. The response message type (google.cloud.functions.v1.GenerateUploadUrlResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GenerateDownloadUrl(google::cloud::functions::v1::GenerateDownloadUrlRequest const &, Options)
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 |
google::cloud::functions::v1::GenerateDownloadUrlRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::functions::v1::GenerateDownloadUrlResponse > | the result of the RPC. The response message type (google.cloud.functions.v1.GenerateDownloadUrlResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)
Sets the IAM access control policy on the specified function.
Replaces any existing policy.
Parameters | |
---|---|
Name | Description |
request |
google::iam::v1::SetIamPolicyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::iam::v1::Policy > | the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)
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 |
google::iam::v1::GetIamPolicyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::iam::v1::Policy > | the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)
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 |
google::iam::v1::TestIamPermissionsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::iam::v1::TestIamPermissionsResponse > | the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |