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 API Calls.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


195
196
197
198
199
200
201
202
203
204
205
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 195

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:


231
232
233
234
235
236
237
238
239
240
241
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 231

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:


265
266
267
268
269
270
271
272
273
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 265

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:


301
302
303
304
305
306
307
308
309
310
311
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 301

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. When making a HTTP PUT request, these two headers need to be specified:
  • content-type: application/zip
  • x-goog-content-length-range: 0,104857600

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


347
348
349
350
351
352
353
354
355
356
357
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 347

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:


379
380
381
382
383
384
385
386
387
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 379

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, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudfunctionsV1::Policy

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


412
413
414
415
416
417
418
419
420
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 412

def get_project_location_function_iam_policy(resource, 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['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:


119
120
121
122
123
124
125
126
127
128
129
130
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 119

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:


452
453
454
455
456
457
458
459
460
461
462
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 452

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:


158
159
160
161
162
163
164
165
166
167
168
169
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 158

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:


488
489
490
491
492
493
494
495
496
497
498
499
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 488

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 access control policy on the specified resource. Replaces any existing policy.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


524
525
526
527
528
529
530
531
532
533
534
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 524

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

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


563
564
565
566
567
568
569
570
571
572
573
# File 'generated/google/apis/cloudfunctions_v1/service.rb', line 563

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