Class: Google::Apis::CloudfunctionsV1beta2::CloudFunctionsService

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

Overview

Cloud Functions API

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

Examples:

require 'google/apis/cloudfunctions_v1beta2'

Cloudfunctions = Google::Apis::CloudfunctionsV1beta2 # 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

Returns a new instance of CloudFunctionsService.


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

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

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.


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

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.


43
44
45
# File 'generated/google/apis/cloudfunctions_v1beta2/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::CloudfunctionsV1beta2::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.

Parameters:

  • name (String)

    Required. The name of the function to be called.

  • call_function_request_object (Google::Apis::CloudfunctionsV1beta2::CallFunctionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


199
200
201
202
203
204
205
206
207
208
209
# File 'generated/google/apis/cloudfunctions_v1beta2/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, 'v1beta2/{+name}:call', options)
  command.request_representation = Google::Apis::CloudfunctionsV1beta2::CallFunctionRequest::Representation
  command.request_object = call_function_request_object
  command.response_representation = Google::Apis::CloudfunctionsV1beta2::CallFunctionResponse::Representation
  command.response_class = Google::Apis::CloudfunctionsV1beta2::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::CloudfunctionsV1beta2::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.

Parameters:

  • location (String)

    Required. The project and location in which the function should be created, specified in the format projects/*/locations/*

  • cloud_function_object (Google::Apis::CloudfunctionsV1beta2::CloudFunction) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


236
237
238
239
240
241
242
243
244
245
246
# File 'generated/google/apis/cloudfunctions_v1beta2/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, 'v1beta2/{+location}/functions', options)
  command.request_representation = Google::Apis::CloudfunctionsV1beta2::CloudFunction::Representation
  command.request_object = cloud_function_object
  command.response_representation = Google::Apis::CloudfunctionsV1beta2::Operation::Representation
  command.response_class = Google::Apis::CloudfunctionsV1beta2::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::CloudfunctionsV1beta2::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.

Parameters:

  • name (String)

    Required. The name of the function which should be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def delete_project_location_function(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta2/{+name}', options)
  command.response_representation = Google::Apis::CloudfunctionsV1beta2::Operation::Representation
  command.response_class = Google::Apis::CloudfunctionsV1beta2::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::CloudfunctionsV1beta2::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

Parameters:

  • name (String)

    The name of function for which source code Google Cloud Storage signed URL should be generated.

  • generate_download_url_request_object (Google::Apis::CloudfunctionsV1beta2::GenerateDownloadUrlRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


306
307
308
309
310
311
312
313
314
315
316
# File 'generated/google/apis/cloudfunctions_v1beta2/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, 'v1beta2/{+name}:generateDownloadUrl', options)
  command.request_representation = Google::Apis::CloudfunctionsV1beta2::GenerateDownloadUrlRequest::Representation
  command.request_object = generate_download_url_request_object
  command.response_representation = Google::Apis::CloudfunctionsV1beta2::GenerateDownloadUrlResponse::Representation
  command.response_class = Google::Apis::CloudfunctionsV1beta2::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::CloudfunctionsV1beta2::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

Parameters:

  • parent (String)

    The project and location in which the Google Cloud Storage signed URL should be generated, specified in the format projects/*/locations/*.

  • generate_upload_url_request_object (Google::Apis::CloudfunctionsV1beta2::GenerateUploadUrlRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


358
359
360
361
362
363
364
365
366
367
368
# File 'generated/google/apis/cloudfunctions_v1beta2/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, 'v1beta2/{+parent}/functions:generateUploadUrl', options)
  command.request_representation = Google::Apis::CloudfunctionsV1beta2::GenerateUploadUrlRequest::Representation
  command.request_object = generate_upload_url_request_object
  command.response_representation = Google::Apis::CloudfunctionsV1beta2::GenerateUploadUrlResponse::Representation
  command.response_class = Google::Apis::CloudfunctionsV1beta2::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::CloudfunctionsV1beta2::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.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+name}', options)
  command.response_representation = Google::Apis::CloudfunctionsV1beta2::Operation::Representation
  command.response_class = Google::Apis::CloudfunctionsV1beta2::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::CloudfunctionsV1beta2::CloudFunction

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

Parameters:

  • name (String)

    Required. The name of the function which details should be obtained.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def get_project_location_function(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+name}', options)
  command.response_representation = Google::Apis::CloudfunctionsV1beta2::CloudFunction::Representation
  command.response_class = Google::Apis::CloudfunctionsV1beta2::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

#list_operations(filter: nil, name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudfunctionsV1beta2::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.

Parameters:

  • filter (String) (defaults to: nil)

    Required. A filter for matching the requested operations.

    The supported formats of filter are:
    To query for a specific function: < code>project:,location:,function:
    To query for all of the latest operations for a project: project:
    ,latest:true

  • name (String) (defaults to: nil)

    Must not be set.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of records that should be returned.
    Requested page size cannot exceed 100. If not set, the default page size is 100.

    Pagination is only supported when querying for a specific function.

  • page_token (String) (defaults to: nil)

    Token identifying which result to start with, which is returned by a previous list call.

    Pagination is only supported when querying for a specific function.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


123
124
125
126
127
128
129
130
131
132
133
134
# File 'generated/google/apis/cloudfunctions_v1beta2/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, 'v1beta2/operations', options)
  command.response_representation = Google::Apis::CloudfunctionsV1beta2::ListOperationsResponse::Representation
  command.response_class = Google::Apis::CloudfunctionsV1beta2::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(location, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudfunctionsV1beta2::ListFunctionsResponse

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

Parameters:

  • location (String)

    Required. The project and location from which the function should be listed, specified in the format projects/*/locations/* If you want to list functions in all locations, use "-" in place of a location. When listing functions in all locations, if one or more location(s) are unreachable, the response will contain functions from all reachable locations along with the names of any unreachable locations.

  • page_size (Fixnum) (defaults to: nil)

    Maximum number of functions to return per call.

  • page_token (String) (defaults to: nil)

    The value returned by the last ListFunctionsResponse; indicates that this is a continuation of a prior ListFunctions call, and that the system should return the next page of data.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


432
433
434
435
436
437
438
439
440
441
442
# File 'generated/google/apis/cloudfunctions_v1beta2/service.rb', line 432

def list_project_location_functions(location, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+location}/functions', options)
  command.response_representation = Google::Apis::CloudfunctionsV1beta2::ListFunctionsResponse::Representation
  command.response_class = Google::Apis::CloudfunctionsV1beta2::ListFunctionsResponse
  command.params['location'] = location unless location.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::CloudfunctionsV1beta2::ListLocationsResponse

Lists information about the supported locations for this service.

Parameters:

  • name (String)

    The resource that owns the locations collection, if applicable.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


162
163
164
165
166
167
168
169
170
171
172
173
# File 'generated/google/apis/cloudfunctions_v1beta2/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, 'v1beta2/{+name}/locations', options)
  command.response_representation = Google::Apis::CloudfunctionsV1beta2::ListLocationsResponse::Representation
  command.response_class = Google::Apis::CloudfunctionsV1beta2::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

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

Updates existing function.

Parameters:

  • name (String)

    Required. The name of the function to be updated.

  • cloud_function_object (Google::Apis::CloudfunctionsV1beta2::CloudFunction) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


465
466
467
468
469
470
471
472
473
474
475
# File 'generated/google/apis/cloudfunctions_v1beta2/service.rb', line 465

def update_project_location_function(name, cloud_function_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1beta2/{+name}', options)
  command.request_representation = Google::Apis::CloudfunctionsV1beta2::CloudFunction::Representation
  command.request_object = cloud_function_object
  command.response_representation = Google::Apis::CloudfunctionsV1beta2::Operation::Representation
  command.response_class = Google::Apis::CloudfunctionsV1beta2::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