2017-03-30 22:30:51 +00:00
|
|
|
# Copyright 2015 Google Inc.
|
|
|
|
#
|
|
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
# you may not use this file except in compliance with the License.
|
|
|
|
# You may obtain a copy of the License at
|
|
|
|
#
|
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
#
|
|
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
# See the License for the specific language governing permissions and
|
|
|
|
# limitations under the License.
|
|
|
|
|
|
|
|
require 'google/apis/core/base_service'
|
|
|
|
require 'google/apis/core/json_representation'
|
|
|
|
require 'google/apis/core/hashable'
|
|
|
|
require 'google/apis/errors'
|
|
|
|
|
|
|
|
module Google
|
|
|
|
module Apis
|
|
|
|
module CloudfunctionsV1
|
2018-05-11 00:36:23 +00:00
|
|
|
# Cloud Functions API
|
2017-03-30 22:30:51 +00:00
|
|
|
#
|
2018-04-19 00:36:08 +00:00
|
|
|
# Manages lightweight user-provided functions executed in response to events.
|
2017-03-30 22:30:51 +00:00
|
|
|
#
|
|
|
|
# @example
|
|
|
|
# require 'google/apis/cloudfunctions_v1'
|
|
|
|
#
|
|
|
|
# Cloudfunctions = Google::Apis::CloudfunctionsV1 # Alias the module
|
|
|
|
# service = Cloudfunctions::CloudFunctionsService.new
|
|
|
|
#
|
|
|
|
# @see https://cloud.google.com/functions
|
|
|
|
class CloudFunctionsService < Google::Apis::Core::BaseService
|
2017-06-02 06:11:31 +00:00
|
|
|
# @return [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.
|
|
|
|
attr_accessor :key
|
|
|
|
|
2017-07-12 20:10:42 +00:00
|
|
|
# @return [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.
|
|
|
|
attr_accessor :quota_user
|
|
|
|
|
2017-03-30 22:30:51 +00:00
|
|
|
def initialize
|
|
|
|
super('https://cloudfunctions.googleapis.com/', '')
|
2017-04-03 20:18:48 +00:00
|
|
|
@batch_path = 'batch'
|
2017-03-30 22:30:51 +00:00
|
|
|
end
|
2017-08-25 19:54:22 +00:00
|
|
|
|
|
|
|
# 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.
|
|
|
|
# @param [String] name
|
|
|
|
# The name of the operation resource.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# 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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudfunctionsV1::Operation] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudfunctionsV1::Operation]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
2017-08-25 19:54:22 +00:00
|
|
|
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
|
|
|
|
|
|
|
|
# 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.
|
|
|
|
# @param [String] filter
|
2018-12-20 00:36:04 +00:00
|
|
|
# Required. A filter for matching the requested operations.<br><br> The
|
2019-10-11 00:37:30 +00:00
|
|
|
# supported formats of <b>filter</b> are:<br> To query for a specific function: <
|
2018-12-20 00:36:04 +00:00
|
|
|
# code>project:*,location:*,function:*</code><br> To query for all of the latest
|
|
|
|
# operations for a project: <code>project:*,latest:true</code>
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] name
|
2018-12-20 00:36:04 +00:00
|
|
|
# Must not be set.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [Fixnum] page_size
|
2019-10-11 00:37:30 +00:00
|
|
|
# The maximum number of records that should be returned.<br> Requested page size
|
|
|
|
# cannot exceed 100. If not set, the default page size is 100.<br><br>
|
|
|
|
# Pagination is only supported when querying for a specific function.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] page_token
|
2019-10-11 00:37:30 +00:00
|
|
|
# Token identifying which result to start with, which is returned by a previous
|
|
|
|
# list call.<br><br> Pagination is only supported when querying for a specific
|
|
|
|
# function.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# 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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudfunctionsV1::ListOperationsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudfunctionsV1::ListOperationsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def list_operations(filter: nil, name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v1/operations', options)
|
2017-08-25 19:54:22 +00:00
|
|
|
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
|
|
|
|
|
|
|
|
# Lists information about the supported locations for this service.
|
|
|
|
# @param [String] name
|
|
|
|
# The resource that owns the locations collection, if applicable.
|
|
|
|
# @param [String] filter
|
|
|
|
# The standard list filter.
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# The standard list page size.
|
|
|
|
# @param [String] page_token
|
|
|
|
# The standard list page token.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# 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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudfunctionsV1::ListLocationsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudfunctionsV1::ListLocationsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v1/{+name}/locations', options)
|
2017-08-25 19:54:22 +00:00
|
|
|
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
|
2017-10-19 00:35:39 +00:00
|
|
|
|
2018-12-14 00:36:18 +00:00
|
|
|
# Synchronously invokes a deployed Cloud Function. To be used for testing
|
|
|
|
# purposes as very limited traffic is allowed. For more information on
|
2019-02-22 00:36:49 +00:00
|
|
|
# the actual limits, refer to
|
|
|
|
# [Rate Limits](https://cloud.google.com/functions/quotas#rate_limits).
|
2017-10-19 00:35:39 +00:00
|
|
|
# @param [String] name
|
2019-09-27 00:37:41 +00:00
|
|
|
# Required. The name of the function to be called.
|
2017-10-19 00:35:39 +00:00
|
|
|
# @param [Google::Apis::CloudfunctionsV1::CallFunctionRequest] call_function_request_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# 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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudfunctionsV1::CallFunctionResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudfunctionsV1::CallFunctionResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def call_function(name, call_function_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v1/{+name}:call', options)
|
2017-10-19 00:35:39 +00:00
|
|
|
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
|
|
|
|
|
|
|
|
# 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.
|
|
|
|
# @param [String] location
|
2019-09-27 00:37:41 +00:00
|
|
|
# Required. The project and location in which the function should be created,
|
|
|
|
# specified
|
2017-10-19 00:35:39 +00:00
|
|
|
# in the format `projects/*/locations/*`
|
|
|
|
# @param [Google::Apis::CloudfunctionsV1::CloudFunction] cloud_function_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# 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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudfunctionsV1::Operation] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudfunctionsV1::Operation]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def create_project_location_function(location, cloud_function_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v1/{+location}/functions', options)
|
2017-10-19 00:35:39 +00:00
|
|
|
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
|
|
|
|
|
|
|
|
# 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.
|
|
|
|
# @param [String] name
|
2019-09-27 00:37:41 +00:00
|
|
|
# Required. The name of the function which should be deleted.
|
2017-10-19 00:35:39 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# 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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudfunctionsV1::Operation] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudfunctionsV1::Operation]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def delete_project_location_function(name, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:delete, 'v1/{+name}', options)
|
2017-10-19 00:35:39 +00:00
|
|
|
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
|
|
|
|
|
|
|
|
# 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
|
|
|
|
# @param [String] name
|
|
|
|
# The name of function for which source code Google Cloud Storage signed
|
|
|
|
# URL should be generated.
|
|
|
|
# @param [Google::Apis::CloudfunctionsV1::GenerateDownloadUrlRequest] generate_download_url_request_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# 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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudfunctionsV1::GenerateDownloadUrlResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudfunctionsV1::GenerateDownloadUrlResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def generate_function_download_url(name, generate_download_url_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v1/{+name}:generateDownloadUrl', options)
|
2017-10-19 00:35:39 +00:00
|
|
|
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
|
|
|
|
|
|
|
|
# Returns a signed URL for uploading a function source code.
|
|
|
|
# For more information about the signed URL usage see:
|
2017-12-19 00:35:20 +00:00
|
|
|
# https://cloud.google.com/storage/docs/access-control/signed-urls.
|
2017-10-19 00:35:39 +00:00
|
|
|
# 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.
|
2017-12-19 00:35:20 +00:00
|
|
|
# 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.
|
2019-02-22 00:36:49 +00:00
|
|
|
# * 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.
|
2017-12-19 00:35:20 +00:00
|
|
|
# When making a HTTP PUT request, these two headers need to be specified:
|
|
|
|
# * `content-type: application/zip`
|
2018-04-19 00:36:08 +00:00
|
|
|
# * `x-goog-content-length-range: 0,104857600`
|
2019-02-22 00:36:49 +00:00
|
|
|
# And this header SHOULD NOT be specified:
|
|
|
|
# * `Authorization: Bearer YOUR_TOKEN`
|
2017-10-19 00:35:39 +00:00
|
|
|
# @param [String] parent
|
|
|
|
# The project and location in which the Google Cloud Storage signed URL
|
2017-12-19 00:35:20 +00:00
|
|
|
# should be generated, specified in the format `projects/*/locations/*`.
|
2017-10-19 00:35:39 +00:00
|
|
|
# @param [Google::Apis::CloudfunctionsV1::GenerateUploadUrlRequest] generate_upload_url_request_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# 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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudfunctionsV1::GenerateUploadUrlResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudfunctionsV1::GenerateUploadUrlResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def generate_function_upload_url(parent, generate_upload_url_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v1/{+parent}/functions:generateUploadUrl', options)
|
2017-10-19 00:35:39 +00:00
|
|
|
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
|
|
|
|
|
|
|
|
# Returns a function with the given name from the requested project.
|
|
|
|
# @param [String] name
|
2019-09-27 00:37:41 +00:00
|
|
|
# Required. The name of the function which details should be obtained.
|
2017-10-19 00:35:39 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# 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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudfunctionsV1::CloudFunction] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudfunctionsV1::CloudFunction]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def get_project_location_function(name, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
2017-10-19 00:35:39 +00:00
|
|
|
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
|
|
|
|
|
2019-02-01 00:36:36 +00:00
|
|
|
# Gets the IAM access control policy for a function.
|
|
|
|
# Returns an empty policy if the function exists and does not have a policy
|
2018-11-06 00:31:47 +00:00
|
|
|
# set.
|
|
|
|
# @param [String] resource
|
|
|
|
# REQUIRED: The resource for which the policy is being requested.
|
|
|
|
# See the operation documentation for the appropriate value for this field.
|
2019-08-20 00:38:36 +00:00
|
|
|
# @param [Fixnum] options_requested_policy_version
|
|
|
|
# Optional. The policy format version to be returned.
|
2019-09-27 00:37:41 +00:00
|
|
|
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
|
|
|
|
# rejected.
|
|
|
|
# Requests for policies with any conditional bindings must specify version 3.
|
|
|
|
# Policies without any conditional bindings may specify any valid value or
|
|
|
|
# leave the field unset.
|
2018-11-06 00:31:47 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# 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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudfunctionsV1::Policy] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudfunctionsV1::Policy]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2019-08-20 00:38:36 +00:00
|
|
|
def get_project_location_function_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
|
2018-11-06 00:31:47 +00:00
|
|
|
command.response_representation = Google::Apis::CloudfunctionsV1::Policy::Representation
|
|
|
|
command.response_class = Google::Apis::CloudfunctionsV1::Policy
|
|
|
|
command.params['resource'] = resource unless resource.nil?
|
2019-08-20 00:38:36 +00:00
|
|
|
command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
|
2018-11-06 00:31:47 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2017-10-19 00:35:39 +00:00
|
|
|
# Returns a list of functions that belong to the requested project.
|
|
|
|
# @param [String] parent
|
|
|
|
# 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.
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Maximum number of functions to return per call.
|
|
|
|
# @param [String] page_token
|
|
|
|
# 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.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# 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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudfunctionsV1::ListFunctionsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudfunctionsV1::ListFunctionsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def list_project_location_functions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v1/{+parent}/functions', options)
|
2017-10-19 00:35:39 +00:00
|
|
|
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
|
|
|
|
|
|
|
|
# Updates existing function.
|
|
|
|
# @param [String] name
|
|
|
|
# A user-defined name of the function. Function names must be unique
|
|
|
|
# globally and match pattern `projects/*/locations/*/functions/*`
|
|
|
|
# @param [Google::Apis::CloudfunctionsV1::CloudFunction] cloud_function_object
|
|
|
|
# @param [String] update_mask
|
|
|
|
# Required list of fields to be updated in this request.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# 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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudfunctionsV1::Operation] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudfunctionsV1::Operation]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def patch_project_location_function(name, cloud_function_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:patch, 'v1/{+name}', options)
|
2017-10-19 00:35:39 +00:00
|
|
|
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
|
2018-11-06 00:31:47 +00:00
|
|
|
|
2019-02-01 00:36:36 +00:00
|
|
|
# Sets the IAM access control policy on the specified function.
|
|
|
|
# Replaces any existing policy.
|
2018-11-06 00:31:47 +00:00
|
|
|
# @param [String] resource
|
|
|
|
# REQUIRED: The resource for which the policy is being specified.
|
|
|
|
# See the operation documentation for the appropriate value for this field.
|
|
|
|
# @param [Google::Apis::CloudfunctionsV1::SetIamPolicyRequest] set_iam_policy_request_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# 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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudfunctionsV1::Policy] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudfunctionsV1::Policy]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def set_function_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
|
2018-11-06 00:31:47 +00:00
|
|
|
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
|
|
|
|
|
2019-02-01 00:36:36 +00:00
|
|
|
# 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
|
2018-11-06 00:31:47 +00:00
|
|
|
# permissions, not a NOT_FOUND error.
|
|
|
|
# @param [String] resource
|
|
|
|
# REQUIRED: The resource for which the policy detail is being requested.
|
|
|
|
# See the operation documentation for the appropriate value for this field.
|
|
|
|
# @param [Google::Apis::CloudfunctionsV1::TestIamPermissionsRequest] test_iam_permissions_request_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# 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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudfunctionsV1::TestIamPermissionsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudfunctionsV1::TestIamPermissionsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def test_function_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
|
2018-11-06 00:31:47 +00:00
|
|
|
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
|
2017-03-30 22:30:51 +00:00
|
|
|
|
|
|
|
protected
|
|
|
|
|
|
|
|
def apply_command_defaults(command)
|
2017-06-02 06:11:31 +00:00
|
|
|
command.query['key'] = key unless key.nil?
|
2017-07-12 20:10:42 +00:00
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2017-03-30 22:30:51 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|