Import refactored library. See MIGRATING.MD for details
This commit is contained in:
Steven Bazyl committed
1 parent
9b7809174d
commit
f584a2cec8
373 files changed
+255715
-474
No files matched your search
@@ -0,0 +1,254 @@
|
||||
# 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 'date'
|
||||
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 TaskqueueV1beta2
|
||||
|
||||
#
|
||||
class Task
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# Time (in seconds since the epoch) at which the task was enqueued.
|
||||
# Corresponds to the JSON property `enqueueTimestamp`
|
||||
# @return [String]
|
||||
attr_accessor :enqueue_timestamp
|
||||
|
||||
# Name of the task.
|
||||
# Corresponds to the JSON property `id`
|
||||
# @return [String]
|
||||
attr_accessor :id
|
||||
|
||||
# The kind of object returned, in this case set to task.
|
||||
# Corresponds to the JSON property `kind`
|
||||
# @return [String]
|
||||
attr_accessor :kind
|
||||
|
||||
# Time (in seconds since the epoch) at which the task lease will expire. This
|
||||
# value is 0 if the task isnt currently leased out to a worker.
|
||||
# Corresponds to the JSON property `leaseTimestamp`
|
||||
# @return [String]
|
||||
attr_accessor :lease_timestamp
|
||||
|
||||
# A bag of bytes which is the task payload. The payload on the JSON side is
|
||||
# always Base64 encoded.
|
||||
# Corresponds to the JSON property `payloadBase64`
|
||||
# @return [String]
|
||||
attr_accessor :payload_base64
|
||||
|
||||
# Name of the queue that the task is in.
|
||||
# Corresponds to the JSON property `queueName`
|
||||
# @return [String]
|
||||
attr_accessor :queue_name
|
||||
|
||||
# The number of leases applied to this task.
|
||||
# Corresponds to the JSON property `retry_count`
|
||||
# @return [Fixnum]
|
||||
attr_accessor :retry_count
|
||||
|
||||
# Tag for the task, could be used later to lease tasks grouped by a specific tag.
|
||||
# Corresponds to the JSON property `tag`
|
||||
# @return [String]
|
||||
attr_accessor :tag
|
||||
|
||||
def initialize(**args)
|
||||
update!(**args)
|
||||
end
|
||||
|
||||
# Update properties of this object
|
||||
def update!(**args)
|
||||
@enqueue_timestamp = args[:enqueue_timestamp] unless args[:enqueue_timestamp].nil?
|
||||
@id = args[:id] unless args[:id].nil?
|
||||
@kind = args[:kind] unless args[:kind].nil?
|
||||
@lease_timestamp = args[:lease_timestamp] unless args[:lease_timestamp].nil?
|
||||
@payload_base64 = args[:payload_base64] unless args[:payload_base64].nil?
|
||||
@queue_name = args[:queue_name] unless args[:queue_name].nil?
|
||||
@retry_count = args[:retry_count] unless args[:retry_count].nil?
|
||||
@tag = args[:tag] unless args[:tag].nil?
|
||||
end
|
||||
end
|
||||
|
||||
#
|
||||
class TaskQueue
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# ACLs that are applicable to this TaskQueue object.
|
||||
# Corresponds to the JSON property `acl`
|
||||
# @return [Google::Apis::TaskqueueV1beta2::TaskQueue::Acl]
|
||||
attr_accessor :acl
|
||||
|
||||
# Name of the taskqueue.
|
||||
# Corresponds to the JSON property `id`
|
||||
# @return [String]
|
||||
attr_accessor :id
|
||||
|
||||
# The kind of REST object returned, in this case taskqueue.
|
||||
# Corresponds to the JSON property `kind`
|
||||
# @return [String]
|
||||
attr_accessor :kind
|
||||
|
||||
# The number of times we should lease out tasks before giving up on them. If
|
||||
# unset we lease them out forever until a worker deletes the task.
|
||||
# Corresponds to the JSON property `maxLeases`
|
||||
# @return [Fixnum]
|
||||
attr_accessor :max_leases
|
||||
|
||||
# Statistics for the TaskQueue object in question.
|
||||
# Corresponds to the JSON property `stats`
|
||||
# @return [Google::Apis::TaskqueueV1beta2::TaskQueue::Stats]
|
||||
attr_accessor :stats
|
||||
|
||||
def initialize(**args)
|
||||
update!(**args)
|
||||
end
|
||||
|
||||
# Update properties of this object
|
||||
def update!(**args)
|
||||
@acl = args[:acl] unless args[:acl].nil?
|
||||
@id = args[:id] unless args[:id].nil?
|
||||
@kind = args[:kind] unless args[:kind].nil?
|
||||
@max_leases = args[:max_leases] unless args[:max_leases].nil?
|
||||
@stats = args[:stats] unless args[:stats].nil?
|
||||
end
|
||||
|
||||
# ACLs that are applicable to this TaskQueue object.
|
||||
class Acl
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# Email addresses of users who are "admins" of the TaskQueue. This means they
|
||||
# can control the queue, eg set ACLs for the queue.
|
||||
# Corresponds to the JSON property `adminEmails`
|
||||
# @return [Array<String>]
|
||||
attr_accessor :admin_emails
|
||||
|
||||
# Email addresses of users who can "consume" tasks from the TaskQueue. This
|
||||
# means they can Dequeue and Delete tasks from the queue.
|
||||
# Corresponds to the JSON property `consumerEmails`
|
||||
# @return [Array<String>]
|
||||
attr_accessor :consumer_emails
|
||||
|
||||
# Email addresses of users who can "produce" tasks into the TaskQueue. This
|
||||
# means they can Insert tasks into the queue.
|
||||
# Corresponds to the JSON property `producerEmails`
|
||||
# @return [Array<String>]
|
||||
attr_accessor :producer_emails
|
||||
|
||||
def initialize(**args)
|
||||
update!(**args)
|
||||
end
|
||||
|
||||
# Update properties of this object
|
||||
def update!(**args)
|
||||
@admin_emails = args[:admin_emails] unless args[:admin_emails].nil?
|
||||
@consumer_emails = args[:consumer_emails] unless args[:consumer_emails].nil?
|
||||
@producer_emails = args[:producer_emails] unless args[:producer_emails].nil?
|
||||
end
|
||||
end
|
||||
|
||||
# Statistics for the TaskQueue object in question.
|
||||
class Stats
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# Number of tasks leased in the last hour.
|
||||
# Corresponds to the JSON property `leasedLastHour`
|
||||
# @return [String]
|
||||
attr_accessor :leased_last_hour
|
||||
|
||||
# Number of tasks leased in the last minute.
|
||||
# Corresponds to the JSON property `leasedLastMinute`
|
||||
# @return [String]
|
||||
attr_accessor :leased_last_minute
|
||||
|
||||
# The timestamp (in seconds since the epoch) of the oldest unfinished task.
|
||||
# Corresponds to the JSON property `oldestTask`
|
||||
# @return [String]
|
||||
attr_accessor :oldest_task
|
||||
|
||||
# Number of tasks in the queue.
|
||||
# Corresponds to the JSON property `totalTasks`
|
||||
# @return [Fixnum]
|
||||
attr_accessor :total_tasks
|
||||
|
||||
def initialize(**args)
|
||||
update!(**args)
|
||||
end
|
||||
|
||||
# Update properties of this object
|
||||
def update!(**args)
|
||||
@leased_last_hour = args[:leased_last_hour] unless args[:leased_last_hour].nil?
|
||||
@leased_last_minute = args[:leased_last_minute] unless args[:leased_last_minute].nil?
|
||||
@oldest_task = args[:oldest_task] unless args[:oldest_task].nil?
|
||||
@total_tasks = args[:total_tasks] unless args[:total_tasks].nil?
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
#
|
||||
class Tasks
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# The actual list of tasks returned as a result of the lease operation.
|
||||
# Corresponds to the JSON property `items`
|
||||
# @return [Array<Google::Apis::TaskqueueV1beta2::Task>]
|
||||
attr_accessor :items
|
||||
|
||||
# The kind of object returned, a list of tasks.
|
||||
# Corresponds to the JSON property `kind`
|
||||
# @return [String]
|
||||
attr_accessor :kind
|
||||
|
||||
def initialize(**args)
|
||||
update!(**args)
|
||||
end
|
||||
|
||||
# Update properties of this object
|
||||
def update!(**args)
|
||||
@items = args[:items] unless args[:items].nil?
|
||||
@kind = args[:kind] unless args[:kind].nil?
|
||||
end
|
||||
end
|
||||
|
||||
#
|
||||
class Tasks2
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# The actual list of tasks currently active in the TaskQueue.
|
||||
# Corresponds to the JSON property `items`
|
||||
# @return [Array<Google::Apis::TaskqueueV1beta2::Task>]
|
||||
attr_accessor :items
|
||||
|
||||
# The kind of object returned, a list of tasks.
|
||||
# Corresponds to the JSON property `kind`
|
||||
# @return [String]
|
||||
attr_accessor :kind
|
||||
|
||||
def initialize(**args)
|
||||
update!(**args)
|
||||
end
|
||||
|
||||
# Update properties of this object
|
||||
def update!(**args)
|
||||
@items = args[:items] unless args[:items].nil?
|
||||
@kind = args[:kind] unless args[:kind].nil?
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,114 @@
|
||||
# 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 'date'
|
||||
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 TaskqueueV1beta2
|
||||
|
||||
class Task
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
end
|
||||
|
||||
class TaskQueue
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
class Acl
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
end
|
||||
|
||||
class Stats
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
end
|
||||
end
|
||||
|
||||
class Tasks
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
end
|
||||
|
||||
class Tasks2
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
end
|
||||
|
||||
# @private
|
||||
class Task
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :enqueue_timestamp, as: 'enqueueTimestamp'
|
||||
property :id, as: 'id'
|
||||
property :kind, as: 'kind'
|
||||
property :lease_timestamp, as: 'leaseTimestamp'
|
||||
property :payload_base64, as: 'payloadBase64'
|
||||
property :queue_name, as: 'queueName'
|
||||
property :retry_count, as: 'retry_count'
|
||||
property :tag, as: 'tag'
|
||||
end
|
||||
end
|
||||
|
||||
# @private
|
||||
class TaskQueue
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :acl, as: 'acl', class: Google::Apis::TaskqueueV1beta2::TaskQueue::Acl, decorator: Google::Apis::TaskqueueV1beta2::TaskQueue::Acl::Representation
|
||||
|
||||
property :id, as: 'id'
|
||||
property :kind, as: 'kind'
|
||||
property :max_leases, as: 'maxLeases'
|
||||
property :stats, as: 'stats', class: Google::Apis::TaskqueueV1beta2::TaskQueue::Stats, decorator: Google::Apis::TaskqueueV1beta2::TaskQueue::Stats::Representation
|
||||
|
||||
end
|
||||
|
||||
# @private
|
||||
class Acl
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
collection :admin_emails, as: 'adminEmails'
|
||||
collection :consumer_emails, as: 'consumerEmails'
|
||||
collection :producer_emails, as: 'producerEmails'
|
||||
end
|
||||
end
|
||||
|
||||
# @private
|
||||
class Stats
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :leased_last_hour, as: 'leasedLastHour'
|
||||
property :leased_last_minute, as: 'leasedLastMinute'
|
||||
property :oldest_task, as: 'oldestTask'
|
||||
property :total_tasks, as: 'totalTasks'
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# @private
|
||||
class Tasks
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
collection :items, as: 'items', class: Google::Apis::TaskqueueV1beta2::Task, decorator: Google::Apis::TaskqueueV1beta2::Task::Representation
|
||||
|
||||
property :kind, as: 'kind'
|
||||
end
|
||||
end
|
||||
|
||||
# @private
|
||||
class Tasks2
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
collection :items, as: 'items', class: Google::Apis::TaskqueueV1beta2::Task, decorator: Google::Apis::TaskqueueV1beta2::Task::Representation
|
||||
|
||||
property :kind, as: 'kind'
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,416 @@
|
||||
# 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 TaskqueueV1beta2
|
||||
# TaskQueue API
|
||||
#
|
||||
# Lets you access a Google App Engine Pull Task Queue over REST.
|
||||
#
|
||||
# @example
|
||||
# require 'google/apis/taskqueue_v1beta2'
|
||||
#
|
||||
# Taskqueue = Google::Apis::TaskqueueV1beta2 # Alias the module
|
||||
# service = Taskqueue::TaskqueueService.new
|
||||
#
|
||||
# @see https://developers.google.com/appengine/docs/python/taskqueue/rest
|
||||
class TaskqueueService < Google::Apis::Core::BaseService
|
||||
# @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
|
||||
|
||||
# @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.
|
||||
# Overrides userIp if both are provided.
|
||||
attr_accessor :quota_user
|
||||
|
||||
# @return [String]
|
||||
# IP address of the site where the request originates. Use this if you want to
|
||||
# enforce per-user limits.
|
||||
attr_accessor :user_ip
|
||||
|
||||
def initialize
|
||||
super('https://www.googleapis.com/', 'taskqueue/v1beta2/projects/')
|
||||
end
|
||||
|
||||
# Get detailed information about a TaskQueue.
|
||||
# @param [String] project
|
||||
# The project under which the queue lies.
|
||||
# @param [String] taskqueue
|
||||
# The id of the taskqueue to get the properties of.
|
||||
# @param [Boolean] get_stats
|
||||
# Whether to get stats. Optional.
|
||||
# @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.
|
||||
# Overrides userIp if both are provided.
|
||||
# @param [String] user_ip
|
||||
# IP address of the site where the request originates. Use this if you want to
|
||||
# enforce per-user limits.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::TaskqueueV1beta2::TaskQueue] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::TaskqueueV1beta2::TaskQueue]
|
||||
#
|
||||
# @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_taskqueue(project, taskqueue, get_stats: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||||
path = '{project}/taskqueues/{taskqueue}'
|
||||
command = make_simple_command(:get, path, options)
|
||||
command.response_representation = Google::Apis::TaskqueueV1beta2::TaskQueue::Representation
|
||||
command.response_class = Google::Apis::TaskqueueV1beta2::TaskQueue
|
||||
command.params['project'] = project unless project.nil?
|
||||
command.params['taskqueue'] = taskqueue unless taskqueue.nil?
|
||||
command.query['getStats'] = get_stats unless get_stats.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
command.query['userIp'] = user_ip unless user_ip.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Delete a task from a TaskQueue.
|
||||
# @param [String] project
|
||||
# The project under which the queue lies.
|
||||
# @param [String] taskqueue
|
||||
# The taskqueue to delete a task from.
|
||||
# @param [String] task
|
||||
# The id of the task to delete.
|
||||
# @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.
|
||||
# Overrides userIp if both are provided.
|
||||
# @param [String] user_ip
|
||||
# IP address of the site where the request originates. Use this if you want to
|
||||
# enforce per-user limits.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [NilClass] No result returned for this method
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [void]
|
||||
#
|
||||
# @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_task(project, taskqueue, task, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||||
path = '{project}/taskqueues/{taskqueue}/tasks/{task}'
|
||||
command = make_simple_command(:delete, path, options)
|
||||
command.params['project'] = project unless project.nil?
|
||||
command.params['taskqueue'] = taskqueue unless taskqueue.nil?
|
||||
command.params['task'] = task unless task.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
command.query['userIp'] = user_ip unless user_ip.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Get a particular task from a TaskQueue.
|
||||
# @param [String] project
|
||||
# The project under which the queue lies.
|
||||
# @param [String] taskqueue
|
||||
# The taskqueue in which the task belongs.
|
||||
# @param [String] task
|
||||
# The task to get properties of.
|
||||
# @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.
|
||||
# Overrides userIp if both are provided.
|
||||
# @param [String] user_ip
|
||||
# IP address of the site where the request originates. Use this if you want to
|
||||
# enforce per-user limits.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::TaskqueueV1beta2::Task] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::TaskqueueV1beta2::Task]
|
||||
#
|
||||
# @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_task(project, taskqueue, task, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||||
path = '{project}/taskqueues/{taskqueue}/tasks/{task}'
|
||||
command = make_simple_command(:get, path, options)
|
||||
command.response_representation = Google::Apis::TaskqueueV1beta2::Task::Representation
|
||||
command.response_class = Google::Apis::TaskqueueV1beta2::Task
|
||||
command.params['project'] = project unless project.nil?
|
||||
command.params['taskqueue'] = taskqueue unless taskqueue.nil?
|
||||
command.params['task'] = task unless task.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
command.query['userIp'] = user_ip unless user_ip.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Insert a new task in a TaskQueue
|
||||
# @param [String] project
|
||||
# The project under which the queue lies
|
||||
# @param [String] taskqueue
|
||||
# The taskqueue to insert the task into
|
||||
# @param [Google::Apis::TaskqueueV1beta2::Task] task_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.
|
||||
# Overrides userIp if both are provided.
|
||||
# @param [String] user_ip
|
||||
# IP address of the site where the request originates. Use this if you want to
|
||||
# enforce per-user limits.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::TaskqueueV1beta2::Task] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::TaskqueueV1beta2::Task]
|
||||
#
|
||||
# @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 insert_task(project, taskqueue, task_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||||
path = '{project}/taskqueues/{taskqueue}/tasks'
|
||||
command = make_simple_command(:post, path, options)
|
||||
command.request_representation = Google::Apis::TaskqueueV1beta2::Task::Representation
|
||||
command.request_object = task_object
|
||||
command.response_representation = Google::Apis::TaskqueueV1beta2::Task::Representation
|
||||
command.response_class = Google::Apis::TaskqueueV1beta2::Task
|
||||
command.params['project'] = project unless project.nil?
|
||||
command.params['taskqueue'] = taskqueue unless taskqueue.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
command.query['userIp'] = user_ip unless user_ip.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Lease 1 or more tasks from a TaskQueue.
|
||||
# @param [String] project
|
||||
# The project under which the queue lies.
|
||||
# @param [String] taskqueue
|
||||
# The taskqueue to lease a task from.
|
||||
# @param [Boolean] group_by_tag
|
||||
# When true, all returned tasks will have the same tag
|
||||
# @param [Fixnum] lease_secs
|
||||
# The lease in seconds.
|
||||
# @param [Fixnum] num_tasks
|
||||
# The number of tasks to lease.
|
||||
# @param [String] tag
|
||||
# The tag allowed for tasks in the response. Must only be specified if
|
||||
# group_by_tag is true. If group_by_tag is true and tag is not specified the tag
|
||||
# will be that of the oldest task by eta, i.e. the first available tag
|
||||
# @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.
|
||||
# Overrides userIp if both are provided.
|
||||
# @param [String] user_ip
|
||||
# IP address of the site where the request originates. Use this if you want to
|
||||
# enforce per-user limits.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::TaskqueueV1beta2::Tasks] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::TaskqueueV1beta2::Tasks]
|
||||
#
|
||||
# @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 lease_task(project, taskqueue, group_by_tag: nil, lease_secs: nil, num_tasks: nil, tag: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||||
path = '{project}/taskqueues/{taskqueue}/tasks/lease'
|
||||
command = make_simple_command(:post, path, options)
|
||||
command.response_representation = Google::Apis::TaskqueueV1beta2::Tasks::Representation
|
||||
command.response_class = Google::Apis::TaskqueueV1beta2::Tasks
|
||||
command.params['project'] = project unless project.nil?
|
||||
command.params['taskqueue'] = taskqueue unless taskqueue.nil?
|
||||
command.query['groupByTag'] = group_by_tag unless group_by_tag.nil?
|
||||
command.query['leaseSecs'] = lease_secs unless lease_secs.nil?
|
||||
command.query['numTasks'] = num_tasks unless num_tasks.nil?
|
||||
command.query['tag'] = tag unless tag.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
command.query['userIp'] = user_ip unless user_ip.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# List Tasks in a TaskQueue
|
||||
# @param [String] project
|
||||
# The project under which the queue lies.
|
||||
# @param [String] taskqueue
|
||||
# The id of the taskqueue to list tasks from.
|
||||
# @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.
|
||||
# Overrides userIp if both are provided.
|
||||
# @param [String] user_ip
|
||||
# IP address of the site where the request originates. Use this if you want to
|
||||
# enforce per-user limits.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::TaskqueueV1beta2::Tasks2] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::TaskqueueV1beta2::Tasks2]
|
||||
#
|
||||
# @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_tasks(project, taskqueue, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||||
path = '{project}/taskqueues/{taskqueue}/tasks'
|
||||
command = make_simple_command(:get, path, options)
|
||||
command.response_representation = Google::Apis::TaskqueueV1beta2::Tasks2::Representation
|
||||
command.response_class = Google::Apis::TaskqueueV1beta2::Tasks2
|
||||
command.params['project'] = project unless project.nil?
|
||||
command.params['taskqueue'] = taskqueue unless taskqueue.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
command.query['userIp'] = user_ip unless user_ip.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Update tasks that are leased out of a TaskQueue. This method supports patch
|
||||
# semantics.
|
||||
# @param [String] project
|
||||
# The project under which the queue lies.
|
||||
# @param [String] taskqueue
|
||||
# @param [String] task
|
||||
# @param [Google::Apis::TaskqueueV1beta2::Task] task_object
|
||||
# @param [Fixnum] new_lease_seconds
|
||||
# The new lease in seconds.
|
||||
# @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.
|
||||
# Overrides userIp if both are provided.
|
||||
# @param [String] user_ip
|
||||
# IP address of the site where the request originates. Use this if you want to
|
||||
# enforce per-user limits.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::TaskqueueV1beta2::Task] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::TaskqueueV1beta2::Task]
|
||||
#
|
||||
# @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_task(project, taskqueue, task, task_object = nil, new_lease_seconds: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||||
path = '{project}/taskqueues/{taskqueue}/tasks/{task}'
|
||||
command = make_simple_command(:patch, path, options)
|
||||
command.request_representation = Google::Apis::TaskqueueV1beta2::Task::Representation
|
||||
command.request_object = task_object
|
||||
command.response_representation = Google::Apis::TaskqueueV1beta2::Task::Representation
|
||||
command.response_class = Google::Apis::TaskqueueV1beta2::Task
|
||||
command.params['project'] = project unless project.nil?
|
||||
command.params['taskqueue'] = taskqueue unless taskqueue.nil?
|
||||
command.params['task'] = task unless task.nil?
|
||||
command.query['newLeaseSeconds'] = new_lease_seconds unless new_lease_seconds.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
command.query['userIp'] = user_ip unless user_ip.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Update tasks that are leased out of a TaskQueue.
|
||||
# @param [String] project
|
||||
# The project under which the queue lies.
|
||||
# @param [String] taskqueue
|
||||
# @param [String] task
|
||||
# @param [Google::Apis::TaskqueueV1beta2::Task] task_object
|
||||
# @param [Fixnum] new_lease_seconds
|
||||
# The new lease in seconds.
|
||||
# @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.
|
||||
# Overrides userIp if both are provided.
|
||||
# @param [String] user_ip
|
||||
# IP address of the site where the request originates. Use this if you want to
|
||||
# enforce per-user limits.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::TaskqueueV1beta2::Task] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::TaskqueueV1beta2::Task]
|
||||
#
|
||||
# @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 update_task(project, taskqueue, task, task_object = nil, new_lease_seconds: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||||
path = '{project}/taskqueues/{taskqueue}/tasks/{task}'
|
||||
command = make_simple_command(:post, path, options)
|
||||
command.request_representation = Google::Apis::TaskqueueV1beta2::Task::Representation
|
||||
command.request_object = task_object
|
||||
command.response_representation = Google::Apis::TaskqueueV1beta2::Task::Representation
|
||||
command.response_class = Google::Apis::TaskqueueV1beta2::Task
|
||||
command.params['project'] = project unless project.nil?
|
||||
command.params['taskqueue'] = taskqueue unless taskqueue.nil?
|
||||
command.params['task'] = task unless task.nil?
|
||||
command.query['newLeaseSeconds'] = new_lease_seconds unless new_lease_seconds.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
command.query['userIp'] = user_ip unless user_ip.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
protected
|
||||
|
||||
def apply_command_defaults(command)
|
||||
command.query['key'] = key unless key.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
command.query['userIp'] = user_ip unless user_ip.nil?
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
Reference in new issue
Block a user