Class: Google::Apis::CloudfunctionsV1::CloudFunctionsService

Inherits:
Google::Apis::Core::BaseService show all
Defined in:
generated/google/apis/cloudfunctions_v1/service.rb

Overview

Cloud Functions API

Manages lightweight user-provided functions executed in response to events.

Examples:

require 'google/apis/cloudfunctions_v1'

Cloudfunctions = Google::Apis::CloudfunctionsV1 # Alias the module
service = Cloudfunctions::CloudFunctionsService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Google::Apis::Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Google::Apis::Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Google::Apis::Core::Logging

#logger

Constructor Details

#initializeCloudFunctionsService


45
46
47
48
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 45

def initialize
  super('https://cloudfunctions.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString


38
39
40
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 38

def key
  @key
end

#quota_userString


43
44
45
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#call_function(name, call_function_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudfunctionsV1::CallFunctionResponse

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


199
200
201
202
203
204
205
206
207
208
209
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 199

def call_function(name, call_function_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:call', options)
  command.request_representation = Google::Apis::CloudfunctionsV1::CallFunctionRequest::Representation
  command.request_object = call_function_request_object
  command.response_representation = Google::Apis::CloudfunctionsV1::CallFunctionResponse::Representation
  command.response_class = Google::Apis::CloudfunctionsV1::CallFunctionResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_function(location, cloud_function_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudfunctionsV1::Operation

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


236
237
238
239
240
241
242
243
244
245
246
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 236

def create_project_location_function(location, cloud_function_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+location}/functions', options)
  command.request_representation = Google::Apis::CloudfunctionsV1::CloudFunction::Representation
  command.request_object = cloud_function_object
  command.response_representation = Google::Apis::CloudfunctionsV1::Operation::Representation
  command.response_class = Google::Apis::CloudfunctionsV1::Operation
  command.params['location'] = location unless location.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_function(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudfunctionsV1::Operation

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


270
271
272
273
274
275
276
277
278
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 270

def delete_project_location_function(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CloudfunctionsV1::Operation::Representation
  command.response_class = Google::Apis::CloudfunctionsV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_function_download_url(name, generate_download_url_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudfunctionsV1::GenerateDownloadUrlResponse

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


306
307
308
309
310
311
312
313
314
315
316
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 306

def generate_function_download_url(name, generate_download_url_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:generateDownloadUrl', options)
  command.request_representation = Google::Apis::CloudfunctionsV1::GenerateDownloadUrlRequest::Representation
  command.request_object = generate_download_url_request_object
  command.response_representation = Google::Apis::CloudfunctionsV1::GenerateDownloadUrlResponse::Representation
  command.response_class = Google::Apis::CloudfunctionsV1::GenerateDownloadUrlResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_function_upload_url(parent, generate_upload_url_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudfunctionsV1::GenerateUploadUrlResponse

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


358
359
360
361
362
363
364
365
366
367
368
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 358

def generate_function_upload_url(parent, generate_upload_url_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/functions:generateUploadUrl', options)
  command.request_representation = Google::Apis::CloudfunctionsV1::GenerateUploadUrlRequest::Representation
  command.request_object = generate_upload_url_request_object
  command.response_representation = Google::Apis::CloudfunctionsV1::GenerateUploadUrlResponse::Representation
  command.response_class = Google::Apis::CloudfunctionsV1::GenerateUploadUrlResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudfunctionsV1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


72
73
74
75
76
77
78
79
80
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 72

def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CloudfunctionsV1::Operation::Representation
  command.response_class = Google::Apis::CloudfunctionsV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_function(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudfunctionsV1::CloudFunction

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


390
391
392
393
394
395
396
397
398
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 390

def get_project_location_function(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CloudfunctionsV1::CloudFunction::Representation
  command.response_class = Google::Apis::CloudfunctionsV1::CloudFunction
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_function_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudfunctionsV1::Policy

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


430
431
432
433
434
435
436
437
438
439
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 430

def get_project_location_function_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::CloudfunctionsV1::Policy::Representation
  command.response_class = Google::Apis::CloudfunctionsV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_operations(filter: nil, name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudfunctionsV1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


123
124
125
126
127
128
129
130
131
132
133
134
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 123

def list_operations(filter: nil, name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/operations', options)
  command.response_representation = Google::Apis::CloudfunctionsV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::CloudfunctionsV1::ListOperationsResponse
  command.query['filter'] = filter unless filter.nil?
  command.query['name'] = name unless name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_functions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudfunctionsV1::ListFunctionsResponse

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


473
474
475
476
477
478
479
480
481
482
483
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 473

def list_project_location_functions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/functions', options)
  command.response_representation = Google::Apis::CloudfunctionsV1::ListFunctionsResponse::Representation
  command.response_class = Google::Apis::CloudfunctionsV1::ListFunctionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudfunctionsV1::ListLocationsResponse

Lists information about the supported locations for this service.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


162
163
164
165
166
167
168
169
170
171
172
173
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 162

def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/locations', options)
  command.response_representation = Google::Apis::CloudfunctionsV1::ListLocationsResponse::Representation
  command.response_class = Google::Apis::CloudfunctionsV1::ListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_function(name, cloud_function_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudfunctionsV1::Operation

Updates existing function.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


509
510
511
512
513
514
515
516
517
518
519
520
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 509

def patch_project_location_function(name, cloud_function_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::CloudfunctionsV1::CloudFunction::Representation
  command.request_object = cloud_function_object
  command.response_representation = Google::Apis::CloudfunctionsV1::Operation::Representation
  command.response_class = Google::Apis::CloudfunctionsV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_function_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudfunctionsV1::Policy

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


545
546
547
548
549
550
551
552
553
554
555
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 545

def set_function_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::CloudfunctionsV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::CloudfunctionsV1::Policy::Representation
  command.response_class = Google::Apis::CloudfunctionsV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_function_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudfunctionsV1::TestIamPermissionsResponse

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


582
583
584
585
586
587
588
589
590
591
592
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 582

def test_function_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::CloudfunctionsV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::CloudfunctionsV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::CloudfunctionsV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end