diff --git a/api_names_out.yaml b/api_names_out.yaml index 4b37c9818..7a1cfefee 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -27748,6 +27748,9 @@ "/cloudtasks:v2beta3/Policy/bindings/binding": binding "/cloudtasks:v2beta3/Policy/etag": etag "/cloudtasks:v2beta3/Policy/version": version +"/cloudtasks:v2beta3/PullMessage": pull_message +"/cloudtasks:v2beta3/PullMessage/payload": payload +"/cloudtasks:v2beta3/PullMessage/tag": tag "/cloudtasks:v2beta3/PurgeQueueRequest": purge_queue_request "/cloudtasks:v2beta3/Queue": queue "/cloudtasks:v2beta3/Queue/appEngineHttpQueue": app_engine_http_queue @@ -27757,7 +27760,14 @@ "/cloudtasks:v2beta3/Queue/retryConfig": retry_config "/cloudtasks:v2beta3/Queue/stackdriverLoggingConfig": stackdriver_logging_config "/cloudtasks:v2beta3/Queue/state": state +"/cloudtasks:v2beta3/Queue/stats": stats "/cloudtasks:v2beta3/Queue/type": type +"/cloudtasks:v2beta3/QueueStats": queue_stats +"/cloudtasks:v2beta3/QueueStats/concurrentDispatchesCount": concurrent_dispatches_count +"/cloudtasks:v2beta3/QueueStats/effectiveExecutionRate": effective_execution_rate +"/cloudtasks:v2beta3/QueueStats/executedLastMinuteCount": executed_last_minute_count +"/cloudtasks:v2beta3/QueueStats/oldestEstimatedArrivalTime": oldest_estimated_arrival_time +"/cloudtasks:v2beta3/QueueStats/tasksCount": tasks_count "/cloudtasks:v2beta3/RateLimits": rate_limits "/cloudtasks:v2beta3/RateLimits/maxBurstSize": max_burst_size "/cloudtasks:v2beta3/RateLimits/maxConcurrentDispatches": max_concurrent_dispatches @@ -27791,6 +27801,7 @@ "/cloudtasks:v2beta3/Task/httpRequest": http_request "/cloudtasks:v2beta3/Task/lastAttempt": last_attempt "/cloudtasks:v2beta3/Task/name": name +"/cloudtasks:v2beta3/Task/pullMessage": pull_message "/cloudtasks:v2beta3/Task/responseCount": response_count "/cloudtasks:v2beta3/Task/scheduleTime": schedule_time "/cloudtasks:v2beta3/Task/view": view @@ -27813,6 +27824,7 @@ "/cloudtasks:v2beta3/cloudtasks.projects.locations.queues.delete/name": name "/cloudtasks:v2beta3/cloudtasks.projects.locations.queues.get": get_project_location_queue "/cloudtasks:v2beta3/cloudtasks.projects.locations.queues.get/name": name +"/cloudtasks:v2beta3/cloudtasks.projects.locations.queues.get/readMask": read_mask "/cloudtasks:v2beta3/cloudtasks.projects.locations.queues.getIamPolicy": get_queue_iam_policy "/cloudtasks:v2beta3/cloudtasks.projects.locations.queues.getIamPolicy/resource": resource "/cloudtasks:v2beta3/cloudtasks.projects.locations.queues.list": list_project_location_queues @@ -27820,6 +27832,7 @@ "/cloudtasks:v2beta3/cloudtasks.projects.locations.queues.list/pageSize": page_size "/cloudtasks:v2beta3/cloudtasks.projects.locations.queues.list/pageToken": page_token "/cloudtasks:v2beta3/cloudtasks.projects.locations.queues.list/parent": parent +"/cloudtasks:v2beta3/cloudtasks.projects.locations.queues.list/readMask": read_mask "/cloudtasks:v2beta3/cloudtasks.projects.locations.queues.patch": patch_project_location_queue "/cloudtasks:v2beta3/cloudtasks.projects.locations.queues.patch/name": name "/cloudtasks:v2beta3/cloudtasks.projects.locations.queues.patch/updateMask": update_mask diff --git a/generated/google/apis/cloudtasks_v2beta3.rb b/generated/google/apis/cloudtasks_v2beta3.rb index c9d44893c..4e8817ff0 100644 --- a/generated/google/apis/cloudtasks_v2beta3.rb +++ b/generated/google/apis/cloudtasks_v2beta3.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/tasks/ module CloudtasksV2beta3 VERSION = 'V2beta3' - REVISION = '20201111' + REVISION = '20201202' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudtasks_v2beta3/classes.rb b/generated/google/apis/cloudtasks_v2beta3/classes.rb index 9bd7e6bbf..ea46dcb82 100644 --- a/generated/google/apis/cloudtasks_v2beta3/classes.rb +++ b/generated/google/apis/cloudtasks_v2beta3/classes.rb @@ -879,6 +879,40 @@ module Google end end + # Pull Message. This proto can only be used for tasks in a queue which has PULL + # type. It currently exists for backwards compatibility with the App Engine Task + # Queue SDK. This message type maybe returned with methods list and get, when + # the response view is FULL. + class PullMessage + include Google::Apis::Core::Hashable + + # A data payload consumed by the worker to execute the task. + # Corresponds to the JSON property `payload` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :payload + + # The tasks's tag. The tag is less than 500 characters. SDK compatibility: + # Although the SDK allows tags to be either string or [bytes](https://cloud. + # google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/ + # taskqueue/TaskOptions.html#tag-byte:A-), only UTF-8 encoded tags can be used + # in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the + # task is returned by Cloud Tasks. + # 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) + @payload = args[:payload] if args.key?(:payload) + @tag = args[:tag] if args.key?(:tag) + end + end + # Request message for PurgeQueue. class PurgeQueueRequest include Google::Apis::Core::Hashable @@ -961,6 +995,11 @@ module Google # @return [String] attr_accessor :state + # Statistics for a queue. + # Corresponds to the JSON property `stats` + # @return [Google::Apis::CloudtasksV2beta3::QueueStats] + attr_accessor :stats + # Immutable. The type of a queue (push or pull). `Queue.type` is an immutable # property of the queue that is set at the queue creation time. When left # unspecified, the default value of `PUSH` is selected. @@ -981,10 +1020,64 @@ module Google @retry_config = args[:retry_config] if args.key?(:retry_config) @stackdriver_logging_config = args[:stackdriver_logging_config] if args.key?(:stackdriver_logging_config) @state = args[:state] if args.key?(:state) + @stats = args[:stats] if args.key?(:stats) @type = args[:type] if args.key?(:type) end end + # Statistics for a queue. + class QueueStats + include Google::Apis::Core::Hashable + + # Output only. The number of requests that the queue has dispatched but has not + # received a reply for yet. + # Corresponds to the JSON property `concurrentDispatchesCount` + # @return [Fixnum] + attr_accessor :concurrent_dispatches_count + + # Output only. The current maximum number of tasks per second executed by the + # queue. The maximum value of this variable is controlled by the RateLimits of + # the Queue. However, this value could be less to avoid overloading the + # endpoints tasks in the queue are targeting. + # Corresponds to the JSON property `effectiveExecutionRate` + # @return [Float] + attr_accessor :effective_execution_rate + + # Output only. The number of tasks that the queue has dispatched and received a + # reply for during the last minute. This variable counts both successful and non- + # successful executions. + # Corresponds to the JSON property `executedLastMinuteCount` + # @return [Fixnum] + attr_accessor :executed_last_minute_count + + # Output only. An estimation of the nearest time in the future where a task in + # the queue is scheduled to be executed. + # Corresponds to the JSON property `oldestEstimatedArrivalTime` + # @return [String] + attr_accessor :oldest_estimated_arrival_time + + # Output only. An estimation of the number of tasks in the queue, that is, the + # tasks in the queue that haven't been executed, the tasks in the queue which + # the queue has dispatched but has not yet received a reply for, and the failed + # tasks that the queue is retrying. + # Corresponds to the JSON property `tasksCount` + # @return [Fixnum] + attr_accessor :tasks_count + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @concurrent_dispatches_count = args[:concurrent_dispatches_count] if args.key?(:concurrent_dispatches_count) + @effective_execution_rate = args[:effective_execution_rate] if args.key?(:effective_execution_rate) + @executed_last_minute_count = args[:executed_last_minute_count] if args.key?(:executed_last_minute_count) + @oldest_estimated_arrival_time = args[:oldest_estimated_arrival_time] if args.key?(:oldest_estimated_arrival_time) + @tasks_count = args[:tasks_count] if args.key?(:tasks_count) + end + end + # Rate limits. This message determines the maximum rate that tasks can be # dispatched by a queue, regardless of whether the dispatch is a first task # attempt or a retry. Note: The debugging command, RunTask, will run a task even @@ -1394,6 +1487,14 @@ module Google # @return [String] attr_accessor :name + # Pull Message. This proto can only be used for tasks in a queue which has PULL + # type. It currently exists for backwards compatibility with the App Engine Task + # Queue SDK. This message type maybe returned with methods list and get, when + # the response view is FULL. + # Corresponds to the JSON property `pullMessage` + # @return [Google::Apis::CloudtasksV2beta3::PullMessage] + attr_accessor :pull_message + # Output only. The number of attempts which have received a response. # Corresponds to the JSON property `responseCount` # @return [Fixnum] @@ -1425,6 +1526,7 @@ module Google @http_request = args[:http_request] if args.key?(:http_request) @last_attempt = args[:last_attempt] if args.key?(:last_attempt) @name = args[:name] if args.key?(:name) + @pull_message = args[:pull_message] if args.key?(:pull_message) @response_count = args[:response_count] if args.key?(:response_count) @schedule_time = args[:schedule_time] if args.key?(:schedule_time) @view = args[:view] if args.key?(:view) diff --git a/generated/google/apis/cloudtasks_v2beta3/representations.rb b/generated/google/apis/cloudtasks_v2beta3/representations.rb index 9d3c6f78c..e5d97914d 100644 --- a/generated/google/apis/cloudtasks_v2beta3/representations.rb +++ b/generated/google/apis/cloudtasks_v2beta3/representations.rb @@ -136,6 +136,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class PullMessage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class PurgeQueueRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -148,6 +154,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class QueueStats + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class RateLimits class Representation < Google::Apis::Core::JsonRepresentation; end @@ -383,6 +395,14 @@ module Google end end + class PullMessage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :payload, :base64 => true, as: 'payload' + property :tag, as: 'tag' + end + end + class PurgeQueueRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -403,10 +423,23 @@ module Google property :stackdriver_logging_config, as: 'stackdriverLoggingConfig', class: Google::Apis::CloudtasksV2beta3::StackdriverLoggingConfig, decorator: Google::Apis::CloudtasksV2beta3::StackdriverLoggingConfig::Representation property :state, as: 'state' + property :stats, as: 'stats', class: Google::Apis::CloudtasksV2beta3::QueueStats, decorator: Google::Apis::CloudtasksV2beta3::QueueStats::Representation + property :type, as: 'type' end end + class QueueStats + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :concurrent_dispatches_count, :numeric_string => true, as: 'concurrentDispatchesCount' + property :effective_execution_rate, as: 'effectiveExecutionRate' + property :executed_last_minute_count, :numeric_string => true, as: 'executedLastMinuteCount' + property :oldest_estimated_arrival_time, as: 'oldestEstimatedArrivalTime' + property :tasks_count, :numeric_string => true, as: 'tasksCount' + end + end + class RateLimits # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -479,6 +512,8 @@ module Google property :last_attempt, as: 'lastAttempt', class: Google::Apis::CloudtasksV2beta3::Attempt, decorator: Google::Apis::CloudtasksV2beta3::Attempt::Representation property :name, as: 'name' + property :pull_message, as: 'pullMessage', class: Google::Apis::CloudtasksV2beta3::PullMessage, decorator: Google::Apis::CloudtasksV2beta3::PullMessage::Representation + property :response_count, as: 'responseCount' property :schedule_time, as: 'scheduleTime' property :view, as: 'view' diff --git a/generated/google/apis/cloudtasks_v2beta3/service.rb b/generated/google/apis/cloudtasks_v2beta3/service.rb index 3841b2d75..1c6214edd 100644 --- a/generated/google/apis/cloudtasks_v2beta3/service.rb +++ b/generated/google/apis/cloudtasks_v2beta3/service.rb @@ -197,6 +197,12 @@ module Google # @param [String] name # Required. The resource name of the queue. For example: `projects/PROJECT_ID/ # locations/LOCATION_ID/queues/QUEUE_ID` + # @param [String] read_mask + # Optional. Read mask is used for a more granular control over what the API + # returns. If the mask is not present all fields will be returned except [Queue. + # stats], if the mask is set to "*" all fields including [Queue.stats] will be + # returned, otherwise only the fields explicitly specified in the mask will be + # returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -214,11 +220,12 @@ module Google # @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_queue(name, fields: nil, quota_user: nil, options: nil, &block) + def get_project_location_queue(name, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta3/{+name}', options) command.response_representation = Google::Apis::CloudtasksV2beta3::Queue::Representation command.response_class = Google::Apis::CloudtasksV2beta3::Queue command.params['name'] = name unless name.nil? + command.query['readMask'] = read_mask unless read_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) @@ -283,6 +290,12 @@ module Google # page_token must be the value of next_page_token returned from the previous # call to ListQueues method. It is an error to switch the value of the filter # while iterating through pages. + # @param [String] read_mask + # Optional. Read mask is used for a more granular control on the queues that the + # API returns. If the mask is not present all fields will be returned except [ + # Queue.stats], if the mask is set to "*" all fields including [Queue.stats] + # will be returned, otherwise only the fields explicitly specified in the mask + # will be returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -300,7 +313,7 @@ module Google # @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_queues(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + def list_project_location_queues(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta3/{+parent}/queues', options) command.response_representation = Google::Apis::CloudtasksV2beta3::ListQueuesResponse::Representation command.response_class = Google::Apis::CloudtasksV2beta3::ListQueuesResponse @@ -308,6 +321,7 @@ module Google 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['readMask'] = read_mask unless read_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) diff --git a/generated/google/apis/cloudtasks_v2beta3/synth.metadata b/generated/google/apis/cloudtasks_v2beta3/synth.metadata index de594db1a..2dbcf5316 100644 --- a/generated/google/apis/cloudtasks_v2beta3/synth.metadata +++ b/generated/google/apis/cloudtasks_v2beta3/synth.metadata @@ -4,7 +4,7 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/google-api-ruby-client.git", - "sha": "68c128a0d3480caeabaeaa3a073946818a3f35d5" + "sha": "0492accc8a44d0f28a484a67f7940d74246ab88d" } } ]