proto_docs/google/cloud/tasks/v2/cloudtasks.rb in google-cloud-tasks-v2-0.8.1 vs proto_docs/google/cloud/tasks/v2/cloudtasks.rb in google-cloud-tasks-v2-0.8.2

- old
+ new

@@ -19,22 +19,22 @@ module Google module Cloud module Tasks module V2 - # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_queues ListQueues}. + # Request message for + # {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_queues ListQueues}. # @!attribute [rw] parent # @return [::String] # Required. The location name. # For example: `projects/PROJECT_ID/locations/LOCATION_ID` # @!attribute [rw] filter # @return [::String] - # `filter` can be used to specify a subset of queues. Any {::Google::Cloud::Tasks::V2::Queue Queue} - # field can be used as a filter and several operators as supported. - # For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as - # described in - # [Stackdriver's Advanced Logs + # `filter` can be used to specify a subset of queues. Any + # {::Google::Cloud::Tasks::V2::Queue Queue} field can be used as a filter and + # several operators as supported. For example: `<=, <, >=, >, !=, =, :`. The + # filter syntax is the same as described in [Stackdriver's Advanced Logs # Filters](https://cloud.google.com/logging/docs/view/advanced_filters). # # Sample filter "state: PAUSED". # # Note that using filters might cause fewer queues than the @@ -44,38 +44,41 @@ # Requested page size. # # The maximum page size is 9800. If unspecified, the page size will # be the maximum. Fewer queues than requested might be returned, # even if more queues exist; use the - # {::Google::Cloud::Tasks::V2::ListQueuesResponse#next_page_token next_page_token} in the - # response to determine if more queues exist. + # {::Google::Cloud::Tasks::V2::ListQueuesResponse#next_page_token next_page_token} + # in the response to determine if more queues exist. # @!attribute [rw] page_token # @return [::String] # A token identifying the page of results to return. # # To request the first page results, page_token must be empty. To # request the next page of results, page_token must be the value of - # {::Google::Cloud::Tasks::V2::ListQueuesResponse#next_page_token next_page_token} returned - # from the previous call to {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_queues ListQueues} - # method. It is an error to switch the value of the - # {::Google::Cloud::Tasks::V2::ListQueuesRequest#filter filter} while iterating through pages. + # {::Google::Cloud::Tasks::V2::ListQueuesResponse#next_page_token next_page_token} + # returned from the previous call to + # {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_queues ListQueues} method. It is an + # error to switch the value of the + # {::Google::Cloud::Tasks::V2::ListQueuesRequest#filter filter} while iterating + # through pages. class ListQueuesRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # Response message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_queues ListQueues}. + # Response message for + # {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_queues ListQueues}. # @!attribute [rw] queues # @return [::Array<::Google::Cloud::Tasks::V2::Queue>] # The list of queues. # @!attribute [rw] next_page_token # @return [::String] # A token to retrieve next page of results. # # To return the next page of results, call - # {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_queues ListQueues} with this value as the - # {::Google::Cloud::Tasks::V2::ListQueuesRequest#page_token page_token}. + # {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_queues ListQueues} with this value + # as the {::Google::Cloud::Tasks::V2::ListQueuesRequest#page_token page_token}. # # If the next_page_token is empty, there are no more results. # # The page token is valid for only 2 hours. class ListQueuesResponse @@ -91,30 +94,33 @@ class GetQueueRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#create_queue CreateQueue}. + # Request message for + # {::Google::Cloud::Tasks::V2::CloudTasks::Client#create_queue CreateQueue}. # @!attribute [rw] parent # @return [::String] # Required. The location name in which the queue will be created. # For example: `projects/PROJECT_ID/locations/LOCATION_ID` # # The list of allowed locations can be obtained by calling Cloud # Tasks' implementation of - # [ListLocations][google.cloud.location.Locations.ListLocations]. + # `::Google::Cloud::Location::Locations::Client#list_locations`. # @!attribute [rw] queue # @return [::Google::Cloud::Tasks::V2::Queue] # Required. The queue to create. # - # [Queue's name][google.cloud.tasks.v2.Queue.name] cannot be the same as an existing queue. + # [Queue's name][google.cloud.tasks.v2.Queue.name] cannot be the same as an + # existing queue. class CreateQueueRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#update_queue UpdateQueue}. + # Request message for + # {::Google::Cloud::Tasks::V2::CloudTasks::Client#update_queue UpdateQueue}. # @!attribute [rw] queue # @return [::Google::Cloud::Tasks::V2::Queue] # Required. The queue to create or update. # # The queue's {::Google::Cloud::Tasks::V2::Queue#name name} must be specified. @@ -130,62 +136,67 @@ class UpdateQueueRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#delete_queue DeleteQueue}. + # Request message for + # {::Google::Cloud::Tasks::V2::CloudTasks::Client#delete_queue DeleteQueue}. # @!attribute [rw] name # @return [::String] # Required. The queue name. For example: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` class DeleteQueueRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#purge_queue PurgeQueue}. + # Request message for + # {::Google::Cloud::Tasks::V2::CloudTasks::Client#purge_queue PurgeQueue}. # @!attribute [rw] name # @return [::String] # Required. The queue name. For example: # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` class PurgeQueueRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#pause_queue PauseQueue}. + # Request message for + # {::Google::Cloud::Tasks::V2::CloudTasks::Client#pause_queue PauseQueue}. # @!attribute [rw] name # @return [::String] # Required. The queue name. For example: # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` class PauseQueueRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#resume_queue ResumeQueue}. + # Request message for + # {::Google::Cloud::Tasks::V2::CloudTasks::Client#resume_queue ResumeQueue}. # @!attribute [rw] name # @return [::String] # Required. The queue name. For example: # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` class ResumeQueueRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # Request message for listing tasks using {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_tasks ListTasks}. + # Request message for listing tasks using + # {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_tasks ListTasks}. # @!attribute [rw] parent # @return [::String] # Required. The queue name. For example: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` # @!attribute [rw] response_view # @return [::Google::Cloud::Tasks::V2::Task::View] - # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2::Task Task} will be - # returned. + # The response_view specifies which subset of the + # {::Google::Cloud::Tasks::V2::Task Task} will be returned. # - # By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC}; not all - # information is retrieved by default because some data, such as + # By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC}; + # not all information is retrieved by default because some data, such as # payloads, might be desirable to return only when needed because # of its large size or because of the sensitivity of data that it # contains. # # Authorization for {::Google::Cloud::Tasks::V2::Task::View::FULL FULL} requires @@ -194,61 +205,63 @@ # @!attribute [rw] page_size # @return [::Integer] # Maximum page size. # # Fewer tasks than requested might be returned, even if more tasks exist; use - # {::Google::Cloud::Tasks::V2::ListTasksResponse#next_page_token next_page_token} in the response to - # determine if more tasks exist. + # {::Google::Cloud::Tasks::V2::ListTasksResponse#next_page_token next_page_token} + # in the response to determine if more tasks exist. # # The maximum page size is 1000. If unspecified, the page size will be the # maximum. # @!attribute [rw] page_token # @return [::String] # A token identifying the page of results to return. # # To request the first page results, page_token must be empty. To # request the next page of results, page_token must be the value of - # {::Google::Cloud::Tasks::V2::ListTasksResponse#next_page_token next_page_token} returned - # from the previous call to {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_tasks ListTasks} - # method. + # {::Google::Cloud::Tasks::V2::ListTasksResponse#next_page_token next_page_token} + # returned from the previous call to + # {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_tasks ListTasks} method. # # The page token is valid for only 2 hours. class ListTasksRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # Response message for listing tasks using {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_tasks ListTasks}. + # Response message for listing tasks using + # {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_tasks ListTasks}. # @!attribute [rw] tasks # @return [::Array<::Google::Cloud::Tasks::V2::Task>] # The list of tasks. # @!attribute [rw] next_page_token # @return [::String] # A token to retrieve next page of results. # # To return the next page of results, call - # {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_tasks ListTasks} with this value as the - # {::Google::Cloud::Tasks::V2::ListTasksRequest#page_token page_token}. + # {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_tasks ListTasks} with this value as + # the {::Google::Cloud::Tasks::V2::ListTasksRequest#page_token page_token}. # # If the next_page_token is empty, there are no more results. class ListTasksResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # Request message for getting a task using {::Google::Cloud::Tasks::V2::CloudTasks::Client#get_task GetTask}. + # Request message for getting a task using + # {::Google::Cloud::Tasks::V2::CloudTasks::Client#get_task GetTask}. # @!attribute [rw] name # @return [::String] # Required. The task name. For example: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` # @!attribute [rw] response_view # @return [::Google::Cloud::Tasks::V2::Task::View] - # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2::Task Task} will be - # returned. + # The response_view specifies which subset of the + # {::Google::Cloud::Tasks::V2::Task Task} will be returned. # - # By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC}; not all - # information is retrieved by default because some data, such as + # By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC}; + # not all information is retrieved by default because some data, such as # payloads, might be desirable to return only when needed because # of its large size or because of the sensitivity of data that it # contains. # # Authorization for {::Google::Cloud::Tasks::V2::Task::View::FULL FULL} requires @@ -257,11 +270,12 @@ class GetTaskRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#create_task CreateTask}. + # Request message for + # {::Google::Cloud::Tasks::V2::CloudTasks::Client#create_task CreateTask}. # @!attribute [rw] parent # @return [::String] # Required. The queue name. For example: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` # @@ -270,17 +284,17 @@ # @return [::Google::Cloud::Tasks::V2::Task] # Required. The task to add. # # Task names have the following format: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. - # The user can optionally specify a task {::Google::Cloud::Tasks::V2::Task#name name}. If a - # name is not specified then the system will generate a random - # unique task id, which will be set in the task returned in the - # {::Google::Cloud::Tasks::V2::Task#name response}. + # The user can optionally specify a task + # {::Google::Cloud::Tasks::V2::Task#name name}. If a name is not specified then + # the system will generate a random unique task id, which will be set in the + # task returned in the {::Google::Cloud::Tasks::V2::Task#name response}. # - # If {::Google::Cloud::Tasks::V2::Task#schedule_time schedule_time} is not set or is in the - # past then Cloud Tasks will set it to the current time. + # If {::Google::Cloud::Tasks::V2::Task#schedule_time schedule_time} is not set or + # is in the past then Cloud Tasks will set it to the current time. # # Task De-duplication: # # Explicitly specifying a task ID enables task de-duplication. If # a task's ID is identical to that of an existing task or a task @@ -291,25 +305,25 @@ # deleted or executed. If the task's queue was created using queue.yaml or # queue.xml, then another task with the same name can't be created # for ~9days after the original task was deleted or executed. # # Because there is an extra lookup cost to identify duplicate task - # names, these {::Google::Cloud::Tasks::V2::CloudTasks::Client#create_task CreateTask} calls have significantly - # increased latency. Using hashed strings for the task id or for - # the prefix of the task id is recommended. Choosing task ids that - # are sequential or have sequential prefixes, for example using a + # names, these {::Google::Cloud::Tasks::V2::CloudTasks::Client#create_task CreateTask} + # calls have significantly increased latency. Using hashed strings for the + # task id or for the prefix of the task id is recommended. Choosing task ids + # that are sequential or have sequential prefixes, for example using a # timestamp, causes an increase in latency and error rates in all # task commands. The infrastructure relies on an approximately # uniform distribution of task ids to store and serve tasks # efficiently. # @!attribute [rw] response_view # @return [::Google::Cloud::Tasks::V2::Task::View] - # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2::Task Task} will be - # returned. + # The response_view specifies which subset of the + # {::Google::Cloud::Tasks::V2::Task Task} will be returned. # - # By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC}; not all - # information is retrieved by default because some data, such as + # By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC}; + # not all information is retrieved by default because some data, such as # payloads, might be desirable to return only when needed because # of its large size or because of the sensitivity of data that it # contains. # # Authorization for {::Google::Cloud::Tasks::V2::Task::View::FULL FULL} requires @@ -337,14 +351,14 @@ # @return [::String] # Required. The task name. For example: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` # @!attribute [rw] response_view # @return [::Google::Cloud::Tasks::V2::Task::View] - # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2::Task Task} will be - # returned. + # The response_view specifies which subset of the + # {::Google::Cloud::Tasks::V2::Task Task} will be returned. # - # By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC}; not all - # information is retrieved by default because some data, such as + # By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC}; + # not all information is retrieved by default because some data, such as # payloads, might be desirable to return only when needed because # of its large size or because of the sensitivity of data that it # contains. # # Authorization for {::Google::Cloud::Tasks::V2::Task::View::FULL FULL} requires