google-cloud-tasks 1.1.0 → 1.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (35) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/lib/google/cloud/tasks.rb +2 -2
  4. data/lib/google/cloud/tasks/v2.rb +2 -2
  5. data/lib/google/cloud/tasks/v2/cloud_tasks_client.rb +15 -45
  6. data/lib/google/cloud/tasks/v2/cloudtasks_pb.rb +2 -1
  7. data/lib/google/cloud/tasks/v2/doc/google/cloud/tasks/v2/cloudtasks.rb +15 -45
  8. data/lib/google/cloud/tasks/v2/doc/google/cloud/tasks/v2/queue.rb +2 -3
  9. data/lib/google/cloud/tasks/v2/doc/google/cloud/tasks/v2/target.rb +16 -10
  10. data/lib/google/cloud/tasks/v2/doc/google/cloud/tasks/v2/task.rb +1 -3
  11. data/lib/google/cloud/tasks/v2/doc/google/iam/v1/policy.rb +2 -2
  12. data/lib/google/cloud/tasks/v2/queue_pb.rb +1 -1
  13. data/lib/google/cloud/tasks/v2/task_pb.rb +1 -1
  14. data/lib/google/cloud/tasks/v2beta2.rb +2 -2
  15. data/lib/google/cloud/tasks/v2beta2/cloud_tasks_client.rb +211 -267
  16. data/lib/google/cloud/tasks/v2beta2/cloudtasks_pb.rb +3 -1
  17. data/lib/google/cloud/tasks/v2beta2/cloudtasks_services_pb.rb +58 -69
  18. data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/cloudtasks.rb +188 -250
  19. data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/queue.rb +57 -81
  20. data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/target.rb +86 -89
  21. data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/task.rb +25 -42
  22. data/lib/google/cloud/tasks/v2beta2/doc/google/iam/v1/policy.rb +2 -2
  23. data/lib/google/cloud/tasks/v2beta2/queue_pb.rb +2 -1
  24. data/lib/google/cloud/tasks/v2beta2/target_pb.rb +0 -1
  25. data/lib/google/cloud/tasks/v2beta2/task_pb.rb +2 -1
  26. data/lib/google/cloud/tasks/v2beta3.rb +2 -2
  27. data/lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb +15 -45
  28. data/lib/google/cloud/tasks/v2beta3/cloudtasks_pb.rb +2 -1
  29. data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/cloudtasks.rb +15 -45
  30. data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/target.rb +5 -5
  31. data/lib/google/cloud/tasks/v2beta3/doc/google/iam/v1/policy.rb +2 -2
  32. data/lib/google/cloud/tasks/v2beta3/queue_pb.rb +1 -1
  33. data/lib/google/cloud/tasks/v2beta3/task_pb.rb +1 -1
  34. data/lib/google/cloud/tasks/version.rb +1 -1
  35. metadata +3 -3
@@ -47,9 +47,7 @@ module Google
47
47
  # An App Engine task is a task that has {Google::Cloud::Tasks::V2::AppEngineHttpRequest AppEngineHttpRequest} set.
48
48
  # @!attribute [rw] schedule_time
49
49
  # @return [Google::Protobuf::Timestamp]
50
- # The time when the task is scheduled to be attempted.
51
- #
52
- # For App Engine queues, this is when the task will be attempted or retried.
50
+ # The time when the task is scheduled to be attempted or retried.
53
51
  #
54
52
  # `schedule_time` will be truncated to the nearest microsecond.
55
53
  # @!attribute [rw] create_time
@@ -79,7 +79,7 @@ module Google
79
79
  # ensure that their change will be applied to the same version of the policy.
80
80
  #
81
81
  # If no `etag` is provided in the call to `setIamPolicy`, then the existing
82
- # policy is overwritten blindly.
82
+ # policy is overwritten.
83
83
  class Policy; end
84
84
 
85
85
  # Associates `members` with a `role`.
@@ -99,7 +99,7 @@ module Google
99
99
  # who is authenticated with a Google account or a service account.
100
100
  #
101
101
  # * `user:{emailid}`: An email address that represents a specific Google
102
- # account. For example, `alice@gmail.com` .
102
+ # account. For example, `alice@example.com` .
103
103
  #
104
104
  #
105
105
  # * `serviceAccount:{emailid}`: An email address that represents a service
@@ -4,10 +4,10 @@
4
4
 
5
5
  require 'google/protobuf'
6
6
 
7
- require 'google/api/annotations_pb'
8
7
  require 'google/cloud/tasks/v2/target_pb'
9
8
  require 'google/protobuf/duration_pb'
10
9
  require 'google/protobuf/timestamp_pb'
10
+ require 'google/api/annotations_pb'
11
11
  Google::Protobuf::DescriptorPool.generated_pool.build do
12
12
  add_message "google.cloud.tasks.v2.Queue" do
13
13
  optional :name, :string, 1
@@ -4,11 +4,11 @@
4
4
 
5
5
  require 'google/protobuf'
6
6
 
7
- require 'google/api/annotations_pb'
8
7
  require 'google/cloud/tasks/v2/target_pb'
9
8
  require 'google/protobuf/duration_pb'
10
9
  require 'google/protobuf/timestamp_pb'
11
10
  require 'google/rpc/status_pb'
11
+ require 'google/api/annotations_pb'
12
12
  Google::Protobuf::DescriptorPool.generated_pool.build do
13
13
  add_message "google.cloud.tasks.v2.Task" do
14
14
  optional :name, :string, 1
@@ -35,7 +35,7 @@ module Google
35
35
  # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
36
36
  # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
37
37
  # 3. [Enable the Cloud Tasks API.](https://console.cloud.google.com/apis/library/tasks.googleapis.com)
38
- # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
38
+ # 4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-tasks/latest/file.AUTHENTICATION.html)
39
39
  #
40
40
  # ### Installation
41
41
  # ```
@@ -54,7 +54,7 @@ module Google
54
54
  #
55
55
  # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
56
56
  # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
57
- # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
57
+ # or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
58
58
  # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
59
59
  # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
60
60
  #
@@ -423,15 +423,14 @@ module Google
423
423
  # Queues are returned in lexicographical order.
424
424
  #
425
425
  # @param parent [String]
426
- # Required.
427
- #
428
- # The location name.
426
+ # Required. The location name.
429
427
  # For example: `projects/PROJECT_ID/locations/LOCATION_ID`
430
428
  # @param filter [String]
431
- # `filter` can be used to specify a subset of queues. Any
432
- # {Google::Cloud::Tasks::V2beta2::Queue Queue} field can be used as a filter and
433
- # several operators as supported. For example: `<=, <, >=, >, !=, =, :`. The
434
- # filter syntax is the same as described in [Stackdriver's Advanced Logs
429
+ # `filter` can be used to specify a subset of queues. Any {Google::Cloud::Tasks::V2beta2::Queue Queue}
430
+ # field can be used as a filter and several operators as supported.
431
+ # For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
432
+ # described in
433
+ # [Stackdriver's Advanced Logs
435
434
  # Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
436
435
  #
437
436
  # Sample filter "app_engine_http_target: *".
@@ -493,9 +492,7 @@ module Google
493
492
  # Gets a queue.
494
493
  #
495
494
  # @param name [String]
496
- # Required.
497
- #
498
- # The resource name of the queue. For example:
495
+ # Required. The resource name of the queue. For example:
499
496
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
500
497
  # @param options [Google::Gax::CallOptions]
501
498
  # Overrides the default settings for this call, e.g, timeout,
@@ -526,8 +523,8 @@ module Google
526
523
  # Creates a queue.
527
524
  #
528
525
  # Queues created with this method allow tasks to live for a maximum of 31
529
- # days. After a task is 31 days old, the task will be deleted regardless of
530
- # whether it was dispatched or not.
526
+ # days. After a task is 31 days old, the task will be deleted regardless of whether
527
+ # it was dispatched or not.
531
528
  #
532
529
  # WARNING: Using this method may have unintended side effects if you are
533
530
  # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
@@ -537,21 +534,16 @@ module Google
537
534
  # this method.
538
535
  #
539
536
  # @param parent [String]
540
- # Required.
541
- #
542
- # The location name in which the queue will be created.
537
+ # Required. The location name in which the queue will be created.
543
538
  # For example: `projects/PROJECT_ID/locations/LOCATION_ID`
544
539
  #
545
540
  # The list of allowed locations can be obtained by calling Cloud
546
541
  # Tasks' implementation of
547
542
  # {Google::Cloud::Location::Locations::ListLocations ListLocations}.
548
543
  # @param queue [Google::Cloud::Tasks::V2beta2::Queue | Hash]
549
- # Required.
550
- #
551
- # The queue to create.
544
+ # Required. The queue to create.
552
545
  #
553
- # {Google::Cloud::Tasks::V2beta2::Queue#name Queue's name} cannot be the same as
554
- # an existing queue.
546
+ # {Google::Cloud::Tasks::V2beta2::Queue#name Queue's name} cannot be the same as an existing queue.
555
547
  # A hash of the same form as `Google::Cloud::Tasks::V2beta2::Queue`
556
548
  # can also be provided.
557
549
  # @param options [Google::Gax::CallOptions]
@@ -591,8 +583,8 @@ module Google
591
583
  # the queue if it does exist.
592
584
  #
593
585
  # Queues created with this method allow tasks to live for a maximum of 31
594
- # days. After a task is 31 days old, the task will be deleted regardless of
595
- # whether it was dispatched or not.
586
+ # days. After a task is 31 days old, the task will be deleted regardless of whether
587
+ # it was dispatched or not.
596
588
  #
597
589
  # WARNING: Using this method may have unintended side effects if you are
598
590
  # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
@@ -602,17 +594,13 @@ module Google
602
594
  # this method.
603
595
  #
604
596
  # @param queue [Google::Cloud::Tasks::V2beta2::Queue | Hash]
605
- # Required.
597
+ # Required. The queue to create or update.
606
598
  #
607
- # The queue to create or update.
608
- #
609
- # The queue's {Google::Cloud::Tasks::V2beta2::Queue#name name} must be
610
- # specified.
599
+ # The queue's {Google::Cloud::Tasks::V2beta2::Queue#name name} must be specified.
611
600
  #
612
601
  # Output only fields cannot be modified using UpdateQueue.
613
602
  # Any value specified for an output only field will be ignored.
614
- # The queue's {Google::Cloud::Tasks::V2beta2::Queue#name name} cannot be
615
- # changed.
603
+ # The queue's {Google::Cloud::Tasks::V2beta2::Queue#name name} cannot be changed.
616
604
  # A hash of the same form as `Google::Cloud::Tasks::V2beta2::Queue`
617
605
  # can also be provided.
618
606
  # @param update_mask [Google::Protobuf::FieldMask | Hash]
@@ -666,9 +654,7 @@ module Google
666
654
  # this method.
667
655
  #
668
656
  # @param name [String]
669
- # Required.
670
- #
671
- # The queue name. For example:
657
+ # Required. The queue name. For example:
672
658
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
673
659
  # @param options [Google::Gax::CallOptions]
674
660
  # Overrides the default settings for this call, e.g, timeout,
@@ -704,9 +690,7 @@ module Google
704
690
  # might be dispatched before the purge takes effect. A purge is irreversible.
705
691
  #
706
692
  # @param name [String]
707
- # Required.
708
- #
709
- # The queue name. For example:
693
+ # Required. The queue name. For example:
710
694
  # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
711
695
  # @param options [Google::Gax::CallOptions]
712
696
  # Overrides the default settings for this call, e.g, timeout,
@@ -738,15 +722,12 @@ module Google
738
722
  #
739
723
  # If a queue is paused then the system will stop dispatching tasks
740
724
  # until the queue is resumed via
741
- # {Google::Cloud::Tasks::V2beta2::CloudTasks::ResumeQueue ResumeQueue}. Tasks can
742
- # still be added when the queue is paused. A queue is paused if its
743
- # {Google::Cloud::Tasks::V2beta2::Queue#state state} is
744
- # {Google::Cloud::Tasks::V2beta2::Queue::State::PAUSED PAUSED}.
725
+ # {Google::Cloud::Tasks::V2beta2::CloudTasks::ResumeQueue ResumeQueue}. Tasks can still be added
726
+ # when the queue is paused. A queue is paused if its
727
+ # {Google::Cloud::Tasks::V2beta2::Queue#state state} is {Google::Cloud::Tasks::V2beta2::Queue::State::PAUSED PAUSED}.
745
728
  #
746
729
  # @param name [String]
747
- # Required.
748
- #
749
- # The queue name. For example:
730
+ # Required. The queue name. For example:
750
731
  # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
751
732
  # @param options [Google::Gax::CallOptions]
752
733
  # Overrides the default settings for this call, e.g, timeout,
@@ -778,11 +759,9 @@ module Google
778
759
  #
779
760
  # This method resumes a queue after it has been
780
761
  # {Google::Cloud::Tasks::V2beta2::Queue::State::PAUSED PAUSED} or
781
- # {Google::Cloud::Tasks::V2beta2::Queue::State::DISABLED DISABLED}. The state of a
782
- # queue is stored in the queue's
783
- # {Google::Cloud::Tasks::V2beta2::Queue#state state}; after calling this method
784
- # it will be set to
785
- # {Google::Cloud::Tasks::V2beta2::Queue::State::RUNNING RUNNING}.
762
+ # {Google::Cloud::Tasks::V2beta2::Queue::State::DISABLED DISABLED}. The state of a queue is stored
763
+ # in the queue's {Google::Cloud::Tasks::V2beta2::Queue#state state}; after calling this method it
764
+ # will be set to {Google::Cloud::Tasks::V2beta2::Queue::State::RUNNING RUNNING}.
786
765
  #
787
766
  # WARNING: Resuming many high-QPS queues at the same time can
788
767
  # lead to target overloading. If you are resuming high-QPS
@@ -791,9 +770,7 @@ module Google
791
770
  # Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
792
771
  #
793
772
  # @param name [String]
794
- # Required.
795
- #
796
- # The queue name. For example:
773
+ # Required. The queue name. For example:
797
774
  # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
798
775
  # @param options [Google::Gax::CallOptions]
799
776
  # Overrides the default settings for this call, e.g, timeout,
@@ -821,9 +798,9 @@ module Google
821
798
  @resume_queue.call(req, options, &block)
822
799
  end
823
800
 
824
- # Gets the access control policy for a
825
- # {Google::Cloud::Tasks::V2beta2::Queue Queue}. Returns an empty policy if the
826
- # resource exists and does not have a policy set.
801
+ # Gets the access control policy for a {Google::Cloud::Tasks::V2beta2::Queue Queue}.
802
+ # Returns an empty policy if the resource exists and does not have a policy
803
+ # set.
827
804
  #
828
805
  # Authorization requires the following
829
806
  # [Google IAM](https://cloud.google.com/iam) permission on the specified
@@ -867,8 +844,8 @@ module Google
867
844
  @get_iam_policy.call(req, options, &block)
868
845
  end
869
846
 
870
- # Sets the access control policy for a
871
- # {Google::Cloud::Tasks::V2beta2::Queue Queue}. Replaces any existing policy.
847
+ # Sets the access control policy for a {Google::Cloud::Tasks::V2beta2::Queue Queue}. Replaces any existing
848
+ # policy.
872
849
  #
873
850
  # Note: The Cloud Console does not check queue-level IAM permissions yet.
874
851
  # Project-level permissions are required to use the Cloud Console.
@@ -920,10 +897,9 @@ module Google
920
897
  @set_iam_policy.call(req, options, &block)
921
898
  end
922
899
 
923
- # Returns permissions that a caller has on a
924
- # {Google::Cloud::Tasks::V2beta2::Queue Queue}. If the resource does not exist,
925
- # this will return an empty set of permissions, not a
926
- # {Google::Rpc::Code::NOT_FOUND NOT_FOUND} error.
900
+ # Returns permissions that a caller has on a {Google::Cloud::Tasks::V2beta2::Queue Queue}.
901
+ # If the resource does not exist, this will return an empty set of
902
+ # permissions, not a {Google::Rpc::Code::NOT_FOUND NOT_FOUND} error.
927
903
  #
928
904
  # Note: This operation is designed to be used for building permission-aware
929
905
  # UIs and command-line tools, not for authorization checking. This operation
@@ -970,33 +946,30 @@ module Google
970
946
 
971
947
  # Lists the tasks in a queue.
972
948
  #
973
- # By default, only the {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}
974
- # view is retrieved due to performance considerations;
975
- # {Google::Cloud::Tasks::V2beta2::ListTasksRequest#response_view response_view}
976
- # controls the subset of information which is returned.
949
+ # By default, only the {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC} view is retrieved
950
+ # due to performance considerations;
951
+ # {Google::Cloud::Tasks::V2beta2::ListTasksRequest#response_view response_view} controls the
952
+ # subset of information which is returned.
977
953
  #
978
954
  # The tasks may be returned in any order. The ordering may change at any
979
955
  # time.
980
956
  #
981
957
  # @param parent [String]
982
- # Required.
983
- #
984
- # The queue name. For example:
958
+ # Required. The queue name. For example:
985
959
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
986
960
  # @param response_view [Google::Cloud::Tasks::V2beta2::Task::View]
987
- # The response_view specifies which subset of the
988
- # {Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
989
- #
990
- # By default response_view is
991
- # {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
992
- # retrieved by default because some data, such as payloads, might be
993
- # desirable to return only when needed because of its large size or because
994
- # of the sensitivity of data that it contains.
995
- #
996
- # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
997
- # requires `cloudtasks.tasks.fullView` [Google
998
- # IAM](https://cloud.google.com/iam/) permission on the
999
- # {Google::Cloud::Tasks::V2beta2::Task Task} resource.
961
+ # The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta2::Task Task} will be
962
+ # returned.
963
+ #
964
+ # By default response_view is {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
965
+ # information is retrieved by default because some data, such as
966
+ # payloads, might be desirable to return only when needed because
967
+ # of its large size or because of the sensitivity of data that it
968
+ # contains.
969
+ #
970
+ # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
971
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
972
+ # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1000
973
  # @param page_size [Integer]
1001
974
  # The maximum number of resources contained in the underlying API
1002
975
  # response. If page streaming is performed per-resource, this
@@ -1052,24 +1025,21 @@ module Google
1052
1025
  # Gets a task.
1053
1026
  #
1054
1027
  # @param name [String]
1055
- # Required.
1056
- #
1057
- # The task name. For example:
1028
+ # Required. The task name. For example:
1058
1029
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
1059
1030
  # @param response_view [Google::Cloud::Tasks::V2beta2::Task::View]
1060
- # The response_view specifies which subset of the
1061
- # {Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
1062
- #
1063
- # By default response_view is
1064
- # {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
1065
- # retrieved by default because some data, such as payloads, might be
1066
- # desirable to return only when needed because of its large size or because
1067
- # of the sensitivity of data that it contains.
1068
- #
1069
- # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
1070
- # requires `cloudtasks.tasks.fullView` [Google
1071
- # IAM](https://cloud.google.com/iam/) permission on the
1072
- # {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1031
+ # The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta2::Task Task} will be
1032
+ # returned.
1033
+ #
1034
+ # By default response_view is {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
1035
+ # information is retrieved by default because some data, such as
1036
+ # payloads, might be desirable to return only when needed because
1037
+ # of its large size or because of the sensitivity of data that it
1038
+ # contains.
1039
+ #
1040
+ # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1041
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
1042
+ # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1073
1043
  # @param options [Google::Gax::CallOptions]
1074
1044
  # Overrides the default settings for this call, e.g, timeout,
1075
1045
  # retries, etc.
@@ -1102,33 +1072,27 @@ module Google
1102
1072
  #
1103
1073
  # Tasks cannot be updated after creation; there is no UpdateTask command.
1104
1074
  #
1105
- # * For {Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget App Engine queues},
1106
- # the maximum task size is
1075
+ # * For {Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget App Engine queues}, the maximum task size is
1107
1076
  # 100KB.
1108
- # * For {Google::Cloud::Tasks::V2beta2::PullTarget pull queues}, the maximum
1109
- # task size is 1MB.
1077
+ # * For {Google::Cloud::Tasks::V2beta2::PullTarget pull queues}, the maximum task size is 1MB.
1110
1078
  #
1111
1079
  # @param parent [String]
1112
- # Required.
1113
- #
1114
- # The queue name. For example:
1080
+ # Required. The queue name. For example:
1115
1081
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
1116
1082
  #
1117
1083
  # The queue must already exist.
1118
1084
  # @param task [Google::Cloud::Tasks::V2beta2::Task | Hash]
1119
- # Required.
1120
- #
1121
- # The task to add.
1085
+ # Required. The task to add.
1122
1086
  #
1123
1087
  # Task names have the following format:
1124
1088
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
1125
- # The user can optionally specify a task
1126
- # {Google::Cloud::Tasks::V2beta2::Task#name name}. If a name is not specified
1127
- # then the system will generate a random unique task id, which will be set in
1128
- # the task returned in the {Google::Cloud::Tasks::V2beta2::Task#name response}.
1089
+ # The user can optionally specify a task {Google::Cloud::Tasks::V2beta2::Task#name name}. If a
1090
+ # name is not specified then the system will generate a random
1091
+ # unique task id, which will be set in the task returned in the
1092
+ # {Google::Cloud::Tasks::V2beta2::Task#name response}.
1129
1093
  #
1130
- # If {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} is not
1131
- # set or is in the past then Cloud Tasks will set it to the current time.
1094
+ # If {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} is not set or is in the
1095
+ # past then Cloud Tasks will set it to the current time.
1132
1096
  #
1133
1097
  # Task De-duplication:
1134
1098
  #
@@ -1143,10 +1107,10 @@ module Google
1143
1107
  # for ~9days after the original task was deleted or completed.
1144
1108
  #
1145
1109
  # Because there is an extra lookup cost to identify duplicate task
1146
- # names, these {Google::Cloud::Tasks::V2beta2::CloudTasks::CreateTask CreateTask}
1147
- # calls have significantly increased latency. Using hashed strings for the
1148
- # task id or for the prefix of the task id is recommended. Choosing task ids
1149
- # that are sequential or have sequential prefixes, for example using a
1110
+ # names, these {Google::Cloud::Tasks::V2beta2::CloudTasks::CreateTask CreateTask} calls have significantly
1111
+ # increased latency. Using hashed strings for the task id or for
1112
+ # the prefix of the task id is recommended. Choosing task ids that
1113
+ # are sequential or have sequential prefixes, for example using a
1150
1114
  # timestamp, causes an increase in latency and error rates in all
1151
1115
  # task commands. The infrastructure relies on an approximately
1152
1116
  # uniform distribution of task ids to store and serve tasks
@@ -1154,19 +1118,18 @@ module Google
1154
1118
  # A hash of the same form as `Google::Cloud::Tasks::V2beta2::Task`
1155
1119
  # can also be provided.
1156
1120
  # @param response_view [Google::Cloud::Tasks::V2beta2::Task::View]
1157
- # The response_view specifies which subset of the
1158
- # {Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
1159
- #
1160
- # By default response_view is
1161
- # {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
1162
- # retrieved by default because some data, such as payloads, might be
1163
- # desirable to return only when needed because of its large size or because
1164
- # of the sensitivity of data that it contains.
1165
- #
1166
- # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
1167
- # requires `cloudtasks.tasks.fullView` [Google
1168
- # IAM](https://cloud.google.com/iam/) permission on the
1169
- # {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1121
+ # The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta2::Task Task} will be
1122
+ # returned.
1123
+ #
1124
+ # By default response_view is {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
1125
+ # information is retrieved by default because some data, such as
1126
+ # payloads, might be desirable to return only when needed because
1127
+ # of its large size or because of the sensitivity of data that it
1128
+ # contains.
1129
+ #
1130
+ # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1131
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
1132
+ # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1170
1133
  # @param options [Google::Gax::CallOptions]
1171
1134
  # Overrides the default settings for this call, e.g, timeout,
1172
1135
  # retries, etc.
@@ -1207,9 +1170,7 @@ module Google
1207
1170
  # failed.
1208
1171
  #
1209
1172
  # @param name [String]
1210
- # Required.
1211
- #
1212
- # The task name. For example:
1173
+ # Required. The task name. For example:
1213
1174
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
1214
1175
  # @param options [Google::Gax::CallOptions]
1215
1176
  # Overrides the default settings for this call, e.g, timeout,
@@ -1242,19 +1203,18 @@ module Google
1242
1203
  #
1243
1204
  # This method is invoked by the worker to obtain a lease. The
1244
1205
  # worker must acknowledge the task via
1245
- # {Google::Cloud::Tasks::V2beta2::CloudTasks::AcknowledgeTask AcknowledgeTask}
1246
- # after they have performed the work associated with the task.
1247
- #
1248
- # The {Google::Cloud::Tasks::V2beta2::PullMessage#payload payload} is intended
1249
- # to store data that the worker needs to perform the work associated with the
1250
- # task. To return the payloads in the
1251
- # {Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response}, set
1252
- # {Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#response_view response_view}
1253
- # to {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}.
1254
- #
1255
- # A maximum of 10 qps of
1256
- # {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} requests are
1257
- # allowed per queue. {Google::Rpc::Code::RESOURCE_EXHAUSTED RESOURCE_EXHAUSTED}
1206
+ # {Google::Cloud::Tasks::V2beta2::CloudTasks::AcknowledgeTask AcknowledgeTask} after they have
1207
+ # performed the work associated with the task.
1208
+ #
1209
+ # The {Google::Cloud::Tasks::V2beta2::PullMessage#payload payload} is intended to store data that
1210
+ # the worker needs to perform the work associated with the task. To
1211
+ # return the payloads in the {Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response}, set
1212
+ # {Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#response_view response_view} to
1213
+ # {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}.
1214
+ #
1215
+ # A maximum of 10 qps of {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks}
1216
+ # requests are allowed per
1217
+ # queue. {Google::Rpc::Code::RESOURCE_EXHAUSTED RESOURCE_EXHAUSTED}
1258
1218
  # is returned when this limit is
1259
1219
  # exceeded. {Google::Rpc::Code::RESOURCE_EXHAUSTED RESOURCE_EXHAUSTED}
1260
1220
  # is also returned when
@@ -1262,18 +1222,25 @@ module Google
1262
1222
  # is exceeded.
1263
1223
  #
1264
1224
  # @param parent [String]
1265
- # Required.
1266
- #
1267
- # The queue name. For example:
1225
+ # Required. The queue name. For example:
1268
1226
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
1269
1227
  # @param lease_duration [Google::Protobuf::Duration | Hash]
1228
+ # Required. The duration of the lease.
1229
+ #
1230
+ # Each task returned in the {Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will
1231
+ # have its {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} set to the current
1232
+ # time plus the `lease_duration`. The task is leased until its
1233
+ # {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}; thus, the task will not be
1234
+ # returned to another {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} call
1235
+ # before its {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}.
1236
+ #
1237
+ #
1270
1238
  # After the worker has successfully finished the work associated
1271
1239
  # with the task, the worker must call via
1272
- # {Google::Cloud::Tasks::V2beta2::CloudTasks::AcknowledgeTask AcknowledgeTask}
1273
- # before the {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}.
1274
- # Otherwise the task will be returned to a later
1275
- # {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} call so that
1276
- # another worker can retry it.
1240
+ # {Google::Cloud::Tasks::V2beta2::CloudTasks::AcknowledgeTask AcknowledgeTask} before the
1241
+ # {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}. Otherwise the task will be
1242
+ # returned to a later {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} call so
1243
+ # that another worker can retry it.
1277
1244
  #
1278
1245
  # The maximum lease duration is 1 week.
1279
1246
  # `lease_duration` will be truncated to the nearest second.
@@ -1286,32 +1253,34 @@ module Google
1286
1253
  # `max_tasks` as possible.
1287
1254
  #
1288
1255
  # The largest that `max_tasks` can be is 1000.
1256
+ #
1257
+ # The maximum total size of a {Google::Cloud::Tasks::V2beta2::LeaseTasksResponse lease tasks response} is
1258
+ # 32 MB. If the sum of all task sizes requested reaches this limit,
1259
+ # fewer tasks than requested are returned.
1289
1260
  # @param response_view [Google::Cloud::Tasks::V2beta2::Task::View]
1290
- # The response_view specifies which subset of the
1291
- # {Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
1292
- #
1293
- # By default response_view is
1294
- # {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
1295
- # retrieved by default because some data, such as payloads, might be
1296
- # desirable to return only when needed because of its large size or because
1297
- # of the sensitivity of data that it contains.
1298
- #
1299
- # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
1300
- # requires `cloudtasks.tasks.fullView` [Google
1301
- # IAM](https://cloud.google.com/iam/) permission on the
1302
- # {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1261
+ # The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta2::Task Task} will be
1262
+ # returned.
1263
+ #
1264
+ # By default response_view is {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
1265
+ # information is retrieved by default because some data, such as
1266
+ # payloads, might be desirable to return only when needed because
1267
+ # of its large size or because of the sensitivity of data that it
1268
+ # contains.
1269
+ #
1270
+ # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1271
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
1272
+ # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1303
1273
  # @param filter [String]
1304
1274
  # `filter` can be used to specify a subset of tasks to lease.
1305
1275
  #
1306
1276
  # When `filter` is set to `tag=<my-tag>` then the
1307
- # {Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will contain only
1308
- # tasks whose {Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} is equal to
1309
- # `<my-tag>`. `<my-tag>` must be less than 500 characters.
1277
+ # {Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will contain only tasks whose
1278
+ # {Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} is equal to `<my-tag>`. `<my-tag>` must be
1279
+ # less than 500 characters.
1310
1280
  #
1311
1281
  # When `filter` is set to `tag_function=oldest_tag()`, only tasks which have
1312
1282
  # the same tag as the task with the oldest
1313
- # {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be
1314
- # returned.
1283
+ # {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be returned.
1315
1284
  #
1316
1285
  # Grammar Syntax:
1317
1286
  #
@@ -1329,9 +1298,8 @@ module Google
1329
1298
  # [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
1330
1299
  # only UTF-8 encoded tags can be used in Cloud Tasks. Tag which
1331
1300
  # aren't UTF-8 encoded can't be used in the
1332
- # {Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#filter filter} and the
1333
- # task's {Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} will be displayed
1334
- # as empty in Cloud Tasks.
1301
+ # {Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#filter filter} and the task's
1302
+ # {Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} will be displayed as empty in Cloud Tasks.
1335
1303
  # @param options [Google::Gax::CallOptions]
1336
1304
  # Overrides the default settings for this call, e.g, timeout,
1337
1305
  # retries, etc.
@@ -1372,31 +1340,26 @@ module Google
1372
1340
  # Acknowledges a pull task.
1373
1341
  #
1374
1342
  # The worker, that is, the entity that
1375
- # {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks leased} this task must
1376
- # call this method to indicate that the work associated with the task has
1377
- # finished.
1343
+ # {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks leased} this task must call this method
1344
+ # to indicate that the work associated with the task has finished.
1378
1345
  #
1379
1346
  # The worker must acknowledge a task within the
1380
- # {Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#lease_duration lease_duration}
1381
- # or the lease will expire and the task will become available to be leased
1347
+ # {Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#lease_duration lease_duration} or the lease
1348
+ # will expire and the task will become available to be leased
1382
1349
  # again. After the task is acknowledged, it will not be returned
1383
1350
  # by a later {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks},
1384
1351
  # {Google::Cloud::Tasks::V2beta2::CloudTasks::GetTask GetTask}, or
1385
1352
  # {Google::Cloud::Tasks::V2beta2::CloudTasks::ListTasks ListTasks}.
1386
1353
  #
1387
1354
  # @param name [String]
1388
- # Required.
1389
- #
1390
- # The task name. For example:
1355
+ # Required. The task name. For example:
1391
1356
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
1392
1357
  # @param schedule_time [Google::Protobuf::Timestamp | Hash]
1393
- # Required.
1394
- #
1395
- # The task's current schedule time, available in the
1358
+ # Required. The task's current schedule time, available in the
1396
1359
  # {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
1397
1360
  # {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} response or
1398
- # {Google::Cloud::Tasks::V2beta2::CloudTasks::RenewLease RenewLease} response.
1399
- # This restriction is to ensure that your worker currently holds the lease.
1361
+ # {Google::Cloud::Tasks::V2beta2::CloudTasks::RenewLease RenewLease} response. This restriction is
1362
+ # to ensure that your worker currently holds the lease.
1400
1363
  # A hash of the same form as `Google::Protobuf::Timestamp`
1401
1364
  # can also be provided.
1402
1365
  # @param options [Google::Gax::CallOptions]
@@ -1434,28 +1397,21 @@ module Google
1434
1397
  #
1435
1398
  # The worker can use this method to extend the lease by a new
1436
1399
  # duration, starting from now. The new task lease will be
1437
- # returned in the task's
1438
- # {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}.
1400
+ # returned in the task's {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}.
1439
1401
  #
1440
1402
  # @param name [String]
1441
- # Required.
1442
- #
1443
- # The task name. For example:
1403
+ # Required. The task name. For example:
1444
1404
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
1445
1405
  # @param schedule_time [Google::Protobuf::Timestamp | Hash]
1446
- # Required.
1447
- #
1448
- # The task's current schedule time, available in the
1406
+ # Required. The task's current schedule time, available in the
1449
1407
  # {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
1450
1408
  # {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} response or
1451
- # {Google::Cloud::Tasks::V2beta2::CloudTasks::RenewLease RenewLease} response.
1452
- # This restriction is to ensure that your worker currently holds the lease.
1409
+ # {Google::Cloud::Tasks::V2beta2::CloudTasks::RenewLease RenewLease} response. This restriction is
1410
+ # to ensure that your worker currently holds the lease.
1453
1411
  # A hash of the same form as `Google::Protobuf::Timestamp`
1454
1412
  # can also be provided.
1455
1413
  # @param lease_duration [Google::Protobuf::Duration | Hash]
1456
- # Required.
1457
- #
1458
- # The desired new lease duration, starting from now.
1414
+ # Required. The desired new lease duration, starting from now.
1459
1415
  #
1460
1416
  #
1461
1417
  # The maximum lease duration is 1 week.
@@ -1463,19 +1419,18 @@ module Google
1463
1419
  # A hash of the same form as `Google::Protobuf::Duration`
1464
1420
  # can also be provided.
1465
1421
  # @param response_view [Google::Cloud::Tasks::V2beta2::Task::View]
1466
- # The response_view specifies which subset of the
1467
- # {Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
1468
- #
1469
- # By default response_view is
1470
- # {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
1471
- # retrieved by default because some data, such as payloads, might be
1472
- # desirable to return only when needed because of its large size or because
1473
- # of the sensitivity of data that it contains.
1474
- #
1475
- # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
1476
- # requires `cloudtasks.tasks.fullView` [Google
1477
- # IAM](https://cloud.google.com/iam/) permission on the
1478
- # {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1422
+ # The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta2::Task Task} will be
1423
+ # returned.
1424
+ #
1425
+ # By default response_view is {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
1426
+ # information is retrieved by default because some data, such as
1427
+ # payloads, might be desirable to return only when needed because
1428
+ # of its large size or because of the sensitivity of data that it
1429
+ # contains.
1430
+ #
1431
+ # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1432
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
1433
+ # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1479
1434
  # @param options [Google::Gax::CallOptions]
1480
1435
  # Overrides the default settings for this call, e.g, timeout,
1481
1436
  # retries, etc.
@@ -1517,39 +1472,34 @@ module Google
1517
1472
  # Cancel a pull task's lease.
1518
1473
  #
1519
1474
  # The worker can use this method to cancel a task's lease by
1520
- # setting its {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}
1521
- # to now. This will make the task available to be leased to the next caller
1522
- # of {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks}.
1475
+ # setting its {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} to now. This will
1476
+ # make the task available to be leased to the next caller of
1477
+ # {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks}.
1523
1478
  #
1524
1479
  # @param name [String]
1525
- # Required.
1526
- #
1527
- # The task name. For example:
1480
+ # Required. The task name. For example:
1528
1481
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
1529
1482
  # @param schedule_time [Google::Protobuf::Timestamp | Hash]
1530
- # Required.
1531
- #
1532
- # The task's current schedule time, available in the
1483
+ # Required. The task's current schedule time, available in the
1533
1484
  # {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
1534
1485
  # {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} response or
1535
- # {Google::Cloud::Tasks::V2beta2::CloudTasks::RenewLease RenewLease} response.
1536
- # This restriction is to ensure that your worker currently holds the lease.
1486
+ # {Google::Cloud::Tasks::V2beta2::CloudTasks::RenewLease RenewLease} response. This restriction is
1487
+ # to ensure that your worker currently holds the lease.
1537
1488
  # A hash of the same form as `Google::Protobuf::Timestamp`
1538
1489
  # can also be provided.
1539
1490
  # @param response_view [Google::Cloud::Tasks::V2beta2::Task::View]
1540
- # The response_view specifies which subset of the
1541
- # {Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
1542
- #
1543
- # By default response_view is
1544
- # {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
1545
- # retrieved by default because some data, such as payloads, might be
1546
- # desirable to return only when needed because of its large size or because
1547
- # of the sensitivity of data that it contains.
1548
- #
1549
- # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
1550
- # requires `cloudtasks.tasks.fullView` [Google
1551
- # IAM](https://cloud.google.com/iam/) permission on the
1552
- # {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1491
+ # The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta2::Task Task} will be
1492
+ # returned.
1493
+ #
1494
+ # By default response_view is {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
1495
+ # information is retrieved by default because some data, such as
1496
+ # payloads, might be desirable to return only when needed because
1497
+ # of its large size or because of the sensitivity of data that it
1498
+ # contains.
1499
+ #
1500
+ # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1501
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
1502
+ # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1553
1503
  # @param options [Google::Gax::CallOptions]
1554
1504
  # Overrides the default settings for this call, e.g, timeout,
1555
1505
  # retries, etc.
@@ -1586,53 +1536,47 @@ module Google
1586
1536
  # Forces a task to run now.
1587
1537
  #
1588
1538
  # When this method is called, Cloud Tasks will dispatch the task, even if
1589
- # the task is already running, the queue has reached its
1590
- # {Google::Cloud::Tasks::V2beta2::RateLimits RateLimits} or is
1591
- # {Google::Cloud::Tasks::V2beta2::Queue::State::PAUSED PAUSED}.
1539
+ # the task is already running, the queue has reached its {Google::Cloud::Tasks::V2beta2::RateLimits RateLimits} or
1540
+ # is {Google::Cloud::Tasks::V2beta2::Queue::State::PAUSED PAUSED}.
1592
1541
  #
1593
1542
  # This command is meant to be used for manual debugging. For
1594
- # example, {Google::Cloud::Tasks::V2beta2::CloudTasks::RunTask RunTask} can be
1595
- # used to retry a failed task after a fix has been made or to manually force
1596
- # a task to be dispatched now.
1543
+ # example, {Google::Cloud::Tasks::V2beta2::CloudTasks::RunTask RunTask} can be used to retry a failed
1544
+ # task after a fix has been made or to manually force a task to be
1545
+ # dispatched now.
1597
1546
  #
1598
1547
  # The dispatched task is returned. That is, the task that is returned
1599
- # contains the {Google::Cloud::Tasks::V2beta2::Task#status status} after the
1600
- # task is dispatched but before the task is received by its target.
1548
+ # contains the {Google::Cloud::Tasks::V2beta2::Task#status status} after the task is dispatched but
1549
+ # before the task is received by its target.
1601
1550
  #
1602
1551
  # If Cloud Tasks receives a successful response from the task's
1603
1552
  # target, then the task will be deleted; otherwise the task's
1604
- # {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be
1605
- # reset to the time that
1606
- # {Google::Cloud::Tasks::V2beta2::CloudTasks::RunTask RunTask} was called plus
1607
- # the retry delay specified in the queue's
1608
- # {Google::Cloud::Tasks::V2beta2::RetryConfig RetryConfig}.
1553
+ # {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be reset to the time that
1554
+ # {Google::Cloud::Tasks::V2beta2::CloudTasks::RunTask RunTask} was called plus the retry delay specified
1555
+ # in the queue's {Google::Cloud::Tasks::V2beta2::RetryConfig RetryConfig}.
1609
1556
  #
1610
1557
  # {Google::Cloud::Tasks::V2beta2::CloudTasks::RunTask RunTask} returns
1611
1558
  # {Google::Rpc::Code::NOT_FOUND NOT_FOUND} when it is called on a
1612
1559
  # task that has already succeeded or permanently failed.
1613
1560
  #
1614
- # {Google::Cloud::Tasks::V2beta2::CloudTasks::RunTask RunTask} cannot be called
1615
- # on a {Google::Cloud::Tasks::V2beta2::PullMessage pull task}.
1561
+ # {Google::Cloud::Tasks::V2beta2::CloudTasks::RunTask RunTask} cannot be called on a
1562
+ # {Google::Cloud::Tasks::V2beta2::PullMessage pull task}.
1616
1563
  #
1617
1564
  # @param name [String]
1618
- # Required.
1619
- #
1620
- # The task name. For example:
1565
+ # Required. The task name. For example:
1621
1566
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
1622
1567
  # @param response_view [Google::Cloud::Tasks::V2beta2::Task::View]
1623
- # The response_view specifies which subset of the
1624
- # {Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
1625
- #
1626
- # By default response_view is
1627
- # {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
1628
- # retrieved by default because some data, such as payloads, might be
1629
- # desirable to return only when needed because of its large size or because
1630
- # of the sensitivity of data that it contains.
1631
- #
1632
- # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
1633
- # requires `cloudtasks.tasks.fullView` [Google
1634
- # IAM](https://cloud.google.com/iam/) permission on the
1635
- # {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1568
+ # The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta2::Task Task} will be
1569
+ # returned.
1570
+ #
1571
+ # By default response_view is {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
1572
+ # information is retrieved by default because some data, such as
1573
+ # payloads, might be desirable to return only when needed because
1574
+ # of its large size or because of the sensitivity of data that it
1575
+ # contains.
1576
+ #
1577
+ # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1578
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
1579
+ # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1636
1580
  # @param options [Google::Gax::CallOptions]
1637
1581
  # Overrides the default settings for this call, e.g, timeout,
1638
1582
  # retries, etc.