google-cloud-tasks 0.6.0 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb +104 -123
- data/lib/google/cloud/tasks/v2beta3/cloudtasks_pb.rb +4 -3
- data/lib/google/cloud/tasks/v2beta3/cloudtasks_services_pb.rb +38 -50
- data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/cloudtasks.rb +92 -116
- data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/queue.rb +55 -67
- data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/target.rb +95 -64
- data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/task.rb +17 -28
- data/lib/google/cloud/tasks/v2beta3/queue_pb.rb +2 -0
- data/lib/google/cloud/tasks/v2beta3/target_pb.rb +14 -0
- data/lib/google/cloud/tasks/v2beta3/task_pb.rb +1 -0
- metadata +22 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e7b87037a995fe972188584cbc334797592b49dedb2c5e29edbcd29cf4a25fa5
|
|
4
|
+
data.tar.gz: dae3830b1db979cbeb12cb0a523b955296e4763a57e7530566a953d4c9ef5dad
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5aeefaad904069bc8cc1b731a4782f93f2f72e4c3a930e2a10c5a5e24f0678b5e831b40c84450e286c5ee0c405fbff2cdc6777cfc4f3070c471062f6e5051ba0
|
|
7
|
+
data.tar.gz: a3b249deeb492dc2325bc7b7903bbf42d89e2ff65ad1cff1623a6cd63a66b3745cd744781e3497127c1373bb136c40528b0777f5c84097f985c94b1247d1e402
|
|
@@ -389,11 +389,11 @@ module Google
|
|
|
389
389
|
# The location name.
|
|
390
390
|
# For example: `projects/PROJECT_ID/locations/LOCATION_ID`
|
|
391
391
|
# @param filter [String]
|
|
392
|
-
# `filter` can be used to specify a subset of queues. Any
|
|
393
|
-
#
|
|
394
|
-
#
|
|
395
|
-
#
|
|
396
|
-
# Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
|
|
392
|
+
# `filter` can be used to specify a subset of queues. Any {Google::Cloud::Tasks::V2beta3::Queue Queue}
|
|
393
|
+
# field can be used as a filter and several operators as supported.
|
|
394
|
+
# For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
|
|
395
|
+
# described in
|
|
396
|
+
# [Stackdriver's Advanced Logs Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
|
|
397
397
|
#
|
|
398
398
|
# Sample filter "state: PAUSED".
|
|
399
399
|
#
|
|
@@ -487,15 +487,14 @@ module Google
|
|
|
487
487
|
# Creates a queue.
|
|
488
488
|
#
|
|
489
489
|
# Queues created with this method allow tasks to live for a maximum of 31
|
|
490
|
-
# days. After a task is 31 days old, the task will be deleted regardless of
|
|
491
|
-
#
|
|
490
|
+
# days. After a task is 31 days old, the task will be deleted regardless of whether
|
|
491
|
+
# it was dispatched or not.
|
|
492
492
|
#
|
|
493
493
|
# WARNING: Using this method may have unintended side effects if you are
|
|
494
494
|
# using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
|
|
495
495
|
# Read
|
|
496
|
-
# [Overview of Queue Management and
|
|
497
|
-
#
|
|
498
|
-
# this method.
|
|
496
|
+
# [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
|
|
497
|
+
# before using this method.
|
|
499
498
|
#
|
|
500
499
|
# @param parent [String]
|
|
501
500
|
# Required.
|
|
@@ -511,8 +510,7 @@ module Google
|
|
|
511
510
|
#
|
|
512
511
|
# The queue to create.
|
|
513
512
|
#
|
|
514
|
-
# {Google::Cloud::Tasks::V2beta3::Queue#name Queue's name} cannot be the same as
|
|
515
|
-
# an existing queue.
|
|
513
|
+
# {Google::Cloud::Tasks::V2beta3::Queue#name Queue's name} cannot be the same as an existing queue.
|
|
516
514
|
# A hash of the same form as `Google::Cloud::Tasks::V2beta3::Queue`
|
|
517
515
|
# can also be provided.
|
|
518
516
|
# @param options [Google::Gax::CallOptions]
|
|
@@ -552,28 +550,25 @@ module Google
|
|
|
552
550
|
# the queue if it does exist.
|
|
553
551
|
#
|
|
554
552
|
# Queues created with this method allow tasks to live for a maximum of 31
|
|
555
|
-
# days. After a task is 31 days old, the task will be deleted regardless of
|
|
556
|
-
#
|
|
553
|
+
# days. After a task is 31 days old, the task will be deleted regardless of whether
|
|
554
|
+
# it was dispatched or not.
|
|
557
555
|
#
|
|
558
556
|
# WARNING: Using this method may have unintended side effects if you are
|
|
559
557
|
# using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
|
|
560
558
|
# Read
|
|
561
|
-
# [Overview of Queue Management and
|
|
562
|
-
#
|
|
563
|
-
# this method.
|
|
559
|
+
# [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
|
|
560
|
+
# before using this method.
|
|
564
561
|
#
|
|
565
562
|
# @param queue [Google::Cloud::Tasks::V2beta3::Queue | Hash]
|
|
566
563
|
# Required.
|
|
567
564
|
#
|
|
568
565
|
# The queue to create or update.
|
|
569
566
|
#
|
|
570
|
-
# The queue's {Google::Cloud::Tasks::V2beta3::Queue#name name} must be
|
|
571
|
-
# specified.
|
|
567
|
+
# The queue's {Google::Cloud::Tasks::V2beta3::Queue#name name} must be specified.
|
|
572
568
|
#
|
|
573
569
|
# Output only fields cannot be modified using UpdateQueue.
|
|
574
570
|
# Any value specified for an output only field will be ignored.
|
|
575
|
-
# The queue's {Google::Cloud::Tasks::V2beta3::Queue#name name} cannot be
|
|
576
|
-
# changed.
|
|
571
|
+
# The queue's {Google::Cloud::Tasks::V2beta3::Queue#name name} cannot be changed.
|
|
577
572
|
# A hash of the same form as `Google::Cloud::Tasks::V2beta3::Queue`
|
|
578
573
|
# can also be provided.
|
|
579
574
|
# @param update_mask [Google::Protobuf::FieldMask | Hash]
|
|
@@ -622,9 +617,8 @@ module Google
|
|
|
622
617
|
# WARNING: Using this method may have unintended side effects if you are
|
|
623
618
|
# using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
|
|
624
619
|
# Read
|
|
625
|
-
# [Overview of Queue Management and
|
|
626
|
-
#
|
|
627
|
-
# this method.
|
|
620
|
+
# [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
|
|
621
|
+
# before using this method.
|
|
628
622
|
#
|
|
629
623
|
# @param name [String]
|
|
630
624
|
# Required.
|
|
@@ -699,10 +693,9 @@ module Google
|
|
|
699
693
|
#
|
|
700
694
|
# If a queue is paused then the system will stop dispatching tasks
|
|
701
695
|
# until the queue is resumed via
|
|
702
|
-
# {Google::Cloud::Tasks::V2beta3::CloudTasks::ResumeQueue ResumeQueue}. Tasks can
|
|
703
|
-
#
|
|
704
|
-
# {Google::Cloud::Tasks::V2beta3::Queue#state state} is
|
|
705
|
-
# {Google::Cloud::Tasks::V2beta3::Queue::State::PAUSED PAUSED}.
|
|
696
|
+
# {Google::Cloud::Tasks::V2beta3::CloudTasks::ResumeQueue ResumeQueue}. Tasks can still be added
|
|
697
|
+
# when the queue is paused. A queue is paused if its
|
|
698
|
+
# {Google::Cloud::Tasks::V2beta3::Queue#state state} is {Google::Cloud::Tasks::V2beta3::Queue::State::PAUSED PAUSED}.
|
|
706
699
|
#
|
|
707
700
|
# @param name [String]
|
|
708
701
|
# Required.
|
|
@@ -739,17 +732,14 @@ module Google
|
|
|
739
732
|
#
|
|
740
733
|
# This method resumes a queue after it has been
|
|
741
734
|
# {Google::Cloud::Tasks::V2beta3::Queue::State::PAUSED PAUSED} or
|
|
742
|
-
# {Google::Cloud::Tasks::V2beta3::Queue::State::DISABLED DISABLED}. The state of a
|
|
743
|
-
#
|
|
744
|
-
# {Google::Cloud::Tasks::V2beta3::Queue
|
|
745
|
-
# it will be set to
|
|
746
|
-
# {Google::Cloud::Tasks::V2beta3::Queue::State::RUNNING RUNNING}.
|
|
735
|
+
# {Google::Cloud::Tasks::V2beta3::Queue::State::DISABLED DISABLED}. The state of a queue is stored
|
|
736
|
+
# in the queue's {Google::Cloud::Tasks::V2beta3::Queue#state state}; after calling this method it
|
|
737
|
+
# will be set to {Google::Cloud::Tasks::V2beta3::Queue::State::RUNNING RUNNING}.
|
|
747
738
|
#
|
|
748
739
|
# WARNING: Resuming many high-QPS queues at the same time can
|
|
749
740
|
# lead to target overloading. If you are resuming high-QPS
|
|
750
741
|
# queues, follow the 500/50/5 pattern described in
|
|
751
|
-
# [Managing Cloud Tasks Scaling
|
|
752
|
-
# Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
|
|
742
|
+
# [Managing Cloud Tasks Scaling Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
|
|
753
743
|
#
|
|
754
744
|
# @param name [String]
|
|
755
745
|
# Required.
|
|
@@ -782,9 +772,9 @@ module Google
|
|
|
782
772
|
@resume_queue.call(req, options, &block)
|
|
783
773
|
end
|
|
784
774
|
|
|
785
|
-
# Gets the access control policy for a
|
|
786
|
-
#
|
|
787
|
-
#
|
|
775
|
+
# Gets the access control policy for a {Google::Cloud::Tasks::V2beta3::Queue Queue}.
|
|
776
|
+
# Returns an empty policy if the resource exists and does not have a policy
|
|
777
|
+
# set.
|
|
788
778
|
#
|
|
789
779
|
# Authorization requires the following
|
|
790
780
|
# [Google IAM](https://cloud.google.com/iam) permission on the specified
|
|
@@ -822,8 +812,8 @@ module Google
|
|
|
822
812
|
@get_iam_policy.call(req, options, &block)
|
|
823
813
|
end
|
|
824
814
|
|
|
825
|
-
# Sets the access control policy for a
|
|
826
|
-
#
|
|
815
|
+
# Sets the access control policy for a {Google::Cloud::Tasks::V2beta3::Queue Queue}. Replaces any existing
|
|
816
|
+
# policy.
|
|
827
817
|
#
|
|
828
818
|
# Note: The Cloud Console does not check queue-level IAM permissions yet.
|
|
829
819
|
# Project-level permissions are required to use the Cloud Console.
|
|
@@ -876,10 +866,9 @@ module Google
|
|
|
876
866
|
@set_iam_policy.call(req, options, &block)
|
|
877
867
|
end
|
|
878
868
|
|
|
879
|
-
# Returns permissions that a caller has on a
|
|
880
|
-
#
|
|
881
|
-
#
|
|
882
|
-
# {Google::Rpc::Code::NOT_FOUND NOT_FOUND} error.
|
|
869
|
+
# Returns permissions that a caller has on a {Google::Cloud::Tasks::V2beta3::Queue Queue}.
|
|
870
|
+
# If the resource does not exist, this will return an empty set of
|
|
871
|
+
# permissions, not a {Google::Rpc::Code::NOT_FOUND NOT_FOUND} error.
|
|
883
872
|
#
|
|
884
873
|
# Note: This operation is designed to be used for building permission-aware
|
|
885
874
|
# UIs and command-line tools, not for authorization checking. This operation
|
|
@@ -927,10 +916,10 @@ module Google
|
|
|
927
916
|
|
|
928
917
|
# Lists the tasks in a queue.
|
|
929
918
|
#
|
|
930
|
-
# By default, only the {Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}
|
|
931
|
-
#
|
|
932
|
-
# {Google::Cloud::Tasks::V2beta3::ListTasksRequest#response_view response_view}
|
|
933
|
-
#
|
|
919
|
+
# By default, only the {Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC} view is retrieved
|
|
920
|
+
# due to performance considerations;
|
|
921
|
+
# {Google::Cloud::Tasks::V2beta3::ListTasksRequest#response_view response_view} controls the
|
|
922
|
+
# subset of information which is returned.
|
|
934
923
|
#
|
|
935
924
|
# The tasks may be returned in any order. The ordering may change at any
|
|
936
925
|
# time.
|
|
@@ -941,19 +930,18 @@ module Google
|
|
|
941
930
|
# The queue name. For example:
|
|
942
931
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
|
943
932
|
# @param response_view [Google::Cloud::Tasks::V2beta3::Task::View]
|
|
944
|
-
# The response_view specifies which subset of the
|
|
945
|
-
#
|
|
946
|
-
#
|
|
947
|
-
# By default response_view is
|
|
948
|
-
#
|
|
949
|
-
#
|
|
950
|
-
#
|
|
951
|
-
#
|
|
952
|
-
#
|
|
953
|
-
# Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL}
|
|
954
|
-
#
|
|
955
|
-
#
|
|
956
|
-
# {Google::Cloud::Tasks::V2beta3::Task Task} resource.
|
|
933
|
+
# The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta3::Task Task} will be
|
|
934
|
+
# returned.
|
|
935
|
+
#
|
|
936
|
+
# By default response_view is {Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all
|
|
937
|
+
# information is retrieved by default because some data, such as
|
|
938
|
+
# payloads, might be desirable to return only when needed because
|
|
939
|
+
# of its large size or because of the sensitivity of data that it
|
|
940
|
+
# contains.
|
|
941
|
+
#
|
|
942
|
+
# Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} requires
|
|
943
|
+
# `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
|
|
944
|
+
# permission on the {Google::Cloud::Tasks::V2beta3::Task Task} resource.
|
|
957
945
|
# @param page_size [Integer]
|
|
958
946
|
# The maximum number of resources contained in the underlying API
|
|
959
947
|
# response. If page streaming is performed per-resource, this
|
|
@@ -1014,19 +1002,18 @@ module Google
|
|
|
1014
1002
|
# The task name. For example:
|
|
1015
1003
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
|
1016
1004
|
# @param response_view [Google::Cloud::Tasks::V2beta3::Task::View]
|
|
1017
|
-
# The response_view specifies which subset of the
|
|
1018
|
-
#
|
|
1019
|
-
#
|
|
1020
|
-
# By default response_view is
|
|
1021
|
-
#
|
|
1022
|
-
#
|
|
1023
|
-
#
|
|
1024
|
-
#
|
|
1025
|
-
#
|
|
1026
|
-
# Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL}
|
|
1027
|
-
#
|
|
1028
|
-
#
|
|
1029
|
-
# {Google::Cloud::Tasks::V2beta3::Task Task} resource.
|
|
1005
|
+
# The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta3::Task Task} will be
|
|
1006
|
+
# returned.
|
|
1007
|
+
#
|
|
1008
|
+
# By default response_view is {Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all
|
|
1009
|
+
# information is retrieved by default because some data, such as
|
|
1010
|
+
# payloads, might be desirable to return only when needed because
|
|
1011
|
+
# of its large size or because of the sensitivity of data that it
|
|
1012
|
+
# contains.
|
|
1013
|
+
#
|
|
1014
|
+
# Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} requires
|
|
1015
|
+
# `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
|
|
1016
|
+
# permission on the {Google::Cloud::Tasks::V2beta3::Task Task} resource.
|
|
1030
1017
|
# @param options [Google::Gax::CallOptions]
|
|
1031
1018
|
# Overrides the default settings for this call, e.g, timeout,
|
|
1032
1019
|
# retries, etc.
|
|
@@ -1059,8 +1046,7 @@ module Google
|
|
|
1059
1046
|
#
|
|
1060
1047
|
# Tasks cannot be updated after creation; there is no UpdateTask command.
|
|
1061
1048
|
#
|
|
1062
|
-
# * For {Google::Cloud::Tasks::V2beta3::AppEngineHttpQueue App Engine queues},
|
|
1063
|
-
# the maximum task size is
|
|
1049
|
+
# * For {Google::Cloud::Tasks::V2beta3::AppEngineHttpQueue App Engine queues}, the maximum task size is
|
|
1064
1050
|
# 100KB.
|
|
1065
1051
|
#
|
|
1066
1052
|
# @param parent [String]
|
|
@@ -1077,13 +1063,13 @@ module Google
|
|
|
1077
1063
|
#
|
|
1078
1064
|
# Task names have the following format:
|
|
1079
1065
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
|
|
1080
|
-
# The user can optionally specify a task
|
|
1081
|
-
#
|
|
1082
|
-
#
|
|
1083
|
-
#
|
|
1066
|
+
# The user can optionally specify a task {Google::Cloud::Tasks::V2beta3::Task#name name}. If a
|
|
1067
|
+
# name is not specified then the system will generate a random
|
|
1068
|
+
# unique task id, which will be set in the task returned in the
|
|
1069
|
+
# {Google::Cloud::Tasks::V2beta3::Task#name response}.
|
|
1084
1070
|
#
|
|
1085
|
-
# If {Google::Cloud::Tasks::V2beta3::Task#schedule_time schedule_time} is not
|
|
1086
|
-
#
|
|
1071
|
+
# If {Google::Cloud::Tasks::V2beta3::Task#schedule_time schedule_time} is not set or is in the
|
|
1072
|
+
# past then Cloud Tasks will set it to the current time.
|
|
1087
1073
|
#
|
|
1088
1074
|
# Task De-duplication:
|
|
1089
1075
|
#
|
|
@@ -1098,10 +1084,10 @@ module Google
|
|
|
1098
1084
|
# for ~9days after the original task was deleted or executed.
|
|
1099
1085
|
#
|
|
1100
1086
|
# Because there is an extra lookup cost to identify duplicate task
|
|
1101
|
-
# names, these {Google::Cloud::Tasks::V2beta3::CloudTasks::CreateTask CreateTask}
|
|
1102
|
-
#
|
|
1103
|
-
#
|
|
1104
|
-
#
|
|
1087
|
+
# names, these {Google::Cloud::Tasks::V2beta3::CloudTasks::CreateTask CreateTask} calls have significantly
|
|
1088
|
+
# increased latency. Using hashed strings for the task id or for
|
|
1089
|
+
# the prefix of the task id is recommended. Choosing task ids that
|
|
1090
|
+
# are sequential or have sequential prefixes, for example using a
|
|
1105
1091
|
# timestamp, causes an increase in latency and error rates in all
|
|
1106
1092
|
# task commands. The infrastructure relies on an approximately
|
|
1107
1093
|
# uniform distribution of task ids to store and serve tasks
|
|
@@ -1109,19 +1095,18 @@ module Google
|
|
|
1109
1095
|
# A hash of the same form as `Google::Cloud::Tasks::V2beta3::Task`
|
|
1110
1096
|
# can also be provided.
|
|
1111
1097
|
# @param response_view [Google::Cloud::Tasks::V2beta3::Task::View]
|
|
1112
|
-
# The response_view specifies which subset of the
|
|
1113
|
-
#
|
|
1114
|
-
#
|
|
1115
|
-
# By default response_view is
|
|
1116
|
-
#
|
|
1117
|
-
#
|
|
1118
|
-
#
|
|
1119
|
-
#
|
|
1120
|
-
#
|
|
1121
|
-
# Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL}
|
|
1122
|
-
#
|
|
1123
|
-
#
|
|
1124
|
-
# {Google::Cloud::Tasks::V2beta3::Task Task} resource.
|
|
1098
|
+
# The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta3::Task Task} will be
|
|
1099
|
+
# returned.
|
|
1100
|
+
#
|
|
1101
|
+
# By default response_view is {Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all
|
|
1102
|
+
# information is retrieved by default because some data, such as
|
|
1103
|
+
# payloads, might be desirable to return only when needed because
|
|
1104
|
+
# of its large size or because of the sensitivity of data that it
|
|
1105
|
+
# contains.
|
|
1106
|
+
#
|
|
1107
|
+
# Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} requires
|
|
1108
|
+
# `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
|
|
1109
|
+
# permission on the {Google::Cloud::Tasks::V2beta3::Task Task} resource.
|
|
1125
1110
|
# @param options [Google::Gax::CallOptions]
|
|
1126
1111
|
# Overrides the default settings for this call, e.g, timeout,
|
|
1127
1112
|
# retries, etc.
|
|
@@ -1195,14 +1180,13 @@ module Google
|
|
|
1195
1180
|
# Forces a task to run now.
|
|
1196
1181
|
#
|
|
1197
1182
|
# When this method is called, Cloud Tasks will dispatch the task, even if
|
|
1198
|
-
# the task is already running, the queue has reached its
|
|
1199
|
-
# {Google::Cloud::Tasks::V2beta3::
|
|
1200
|
-
# {Google::Cloud::Tasks::V2beta3::Queue::State::PAUSED PAUSED}.
|
|
1183
|
+
# the task is already running, the queue has reached its {Google::Cloud::Tasks::V2beta3::RateLimits RateLimits} or
|
|
1184
|
+
# is {Google::Cloud::Tasks::V2beta3::Queue::State::PAUSED PAUSED}.
|
|
1201
1185
|
#
|
|
1202
1186
|
# This command is meant to be used for manual debugging. For
|
|
1203
|
-
# example, {Google::Cloud::Tasks::V2beta3::CloudTasks::RunTask RunTask} can be
|
|
1204
|
-
#
|
|
1205
|
-
#
|
|
1187
|
+
# example, {Google::Cloud::Tasks::V2beta3::CloudTasks::RunTask RunTask} can be used to retry a failed
|
|
1188
|
+
# task after a fix has been made or to manually force a task to be
|
|
1189
|
+
# dispatched now.
|
|
1206
1190
|
#
|
|
1207
1191
|
# The dispatched task is returned. That is, the task that is returned
|
|
1208
1192
|
# contains the {Task#status status} after the task is dispatched but
|
|
@@ -1210,11 +1194,9 @@ module Google
|
|
|
1210
1194
|
#
|
|
1211
1195
|
# If Cloud Tasks receives a successful response from the task's
|
|
1212
1196
|
# target, then the task will be deleted; otherwise the task's
|
|
1213
|
-
# {Google::Cloud::Tasks::V2beta3::Task#schedule_time schedule_time} will be
|
|
1214
|
-
#
|
|
1215
|
-
# {Google::Cloud::Tasks::V2beta3::
|
|
1216
|
-
# the retry delay specified in the queue's
|
|
1217
|
-
# {Google::Cloud::Tasks::V2beta3::RetryConfig RetryConfig}.
|
|
1197
|
+
# {Google::Cloud::Tasks::V2beta3::Task#schedule_time schedule_time} will be reset to the time that
|
|
1198
|
+
# {Google::Cloud::Tasks::V2beta3::CloudTasks::RunTask RunTask} was called plus the retry delay specified
|
|
1199
|
+
# in the queue's {Google::Cloud::Tasks::V2beta3::RetryConfig RetryConfig}.
|
|
1218
1200
|
#
|
|
1219
1201
|
# {Google::Cloud::Tasks::V2beta3::CloudTasks::RunTask RunTask} returns
|
|
1220
1202
|
# {Google::Rpc::Code::NOT_FOUND NOT_FOUND} when it is called on a
|
|
@@ -1226,19 +1208,18 @@ module Google
|
|
|
1226
1208
|
# The task name. For example:
|
|
1227
1209
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
|
1228
1210
|
# @param response_view [Google::Cloud::Tasks::V2beta3::Task::View]
|
|
1229
|
-
# The response_view specifies which subset of the
|
|
1230
|
-
#
|
|
1231
|
-
#
|
|
1232
|
-
# By default response_view is
|
|
1233
|
-
#
|
|
1234
|
-
#
|
|
1235
|
-
#
|
|
1236
|
-
#
|
|
1237
|
-
#
|
|
1238
|
-
# Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL}
|
|
1239
|
-
#
|
|
1240
|
-
#
|
|
1241
|
-
# {Google::Cloud::Tasks::V2beta3::Task Task} resource.
|
|
1211
|
+
# The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta3::Task Task} will be
|
|
1212
|
+
# returned.
|
|
1213
|
+
#
|
|
1214
|
+
# By default response_view is {Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all
|
|
1215
|
+
# information is retrieved by default because some data, such as
|
|
1216
|
+
# payloads, might be desirable to return only when needed because
|
|
1217
|
+
# of its large size or because of the sensitivity of data that it
|
|
1218
|
+
# contains.
|
|
1219
|
+
#
|
|
1220
|
+
# Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} requires
|
|
1221
|
+
# `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
|
|
1222
|
+
# permission on the {Google::Cloud::Tasks::V2beta3::Task Task} resource.
|
|
1242
1223
|
# @param options [Google::Gax::CallOptions]
|
|
1243
1224
|
# Overrides the default settings for this call, e.g, timeout,
|
|
1244
1225
|
# retries, etc.
|
|
@@ -5,12 +5,13 @@
|
|
|
5
5
|
require 'google/protobuf'
|
|
6
6
|
|
|
7
7
|
require 'google/api/annotations_pb'
|
|
8
|
-
require 'google/
|
|
8
|
+
require 'google/api/resource_pb'
|
|
9
|
+
require 'google/protobuf/empty_pb'
|
|
10
|
+
require 'google/protobuf/field_mask_pb'
|
|
9
11
|
require 'google/cloud/tasks/v2beta3/task_pb'
|
|
12
|
+
require 'google/cloud/tasks/v2beta3/queue_pb'
|
|
10
13
|
require 'google/iam/v1/iam_policy_pb'
|
|
11
14
|
require 'google/iam/v1/policy_pb'
|
|
12
|
-
require 'google/protobuf/empty_pb'
|
|
13
|
-
require 'google/protobuf/field_mask_pb'
|
|
14
15
|
require 'google/rpc/code_pb'
|
|
15
16
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
16
17
|
add_message "google.cloud.tasks.v2beta3.ListQueuesRequest" do
|
|
@@ -45,15 +45,14 @@ module Google
|
|
|
45
45
|
# Creates a queue.
|
|
46
46
|
#
|
|
47
47
|
# Queues created with this method allow tasks to live for a maximum of 31
|
|
48
|
-
# days. After a task is 31 days old, the task will be deleted regardless of
|
|
49
|
-
#
|
|
48
|
+
# days. After a task is 31 days old, the task will be deleted regardless of whether
|
|
49
|
+
# it was dispatched or not.
|
|
50
50
|
#
|
|
51
51
|
# WARNING: Using this method may have unintended side effects if you are
|
|
52
52
|
# using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
|
|
53
53
|
# Read
|
|
54
|
-
# [Overview of Queue Management and
|
|
55
|
-
#
|
|
56
|
-
# this method.
|
|
54
|
+
# [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
|
|
55
|
+
# before using this method.
|
|
57
56
|
rpc :CreateQueue, CreateQueueRequest, Queue
|
|
58
57
|
# Updates a queue.
|
|
59
58
|
#
|
|
@@ -61,15 +60,14 @@ module Google
|
|
|
61
60
|
# the queue if it does exist.
|
|
62
61
|
#
|
|
63
62
|
# Queues created with this method allow tasks to live for a maximum of 31
|
|
64
|
-
# days. After a task is 31 days old, the task will be deleted regardless of
|
|
65
|
-
#
|
|
63
|
+
# days. After a task is 31 days old, the task will be deleted regardless of whether
|
|
64
|
+
# it was dispatched or not.
|
|
66
65
|
#
|
|
67
66
|
# WARNING: Using this method may have unintended side effects if you are
|
|
68
67
|
# using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
|
|
69
68
|
# Read
|
|
70
|
-
# [Overview of Queue Management and
|
|
71
|
-
#
|
|
72
|
-
# this method.
|
|
69
|
+
# [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
|
|
70
|
+
# before using this method.
|
|
73
71
|
rpc :UpdateQueue, UpdateQueueRequest, Queue
|
|
74
72
|
# Deletes a queue.
|
|
75
73
|
#
|
|
@@ -81,9 +79,8 @@ module Google
|
|
|
81
79
|
# WARNING: Using this method may have unintended side effects if you are
|
|
82
80
|
# using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
|
|
83
81
|
# Read
|
|
84
|
-
# [Overview of Queue Management and
|
|
85
|
-
#
|
|
86
|
-
# this method.
|
|
82
|
+
# [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
|
|
83
|
+
# before using this method.
|
|
87
84
|
rpc :DeleteQueue, DeleteQueueRequest, Google::Protobuf::Empty
|
|
88
85
|
# Purges a queue by deleting all of its tasks.
|
|
89
86
|
#
|
|
@@ -96,30 +93,26 @@ module Google
|
|
|
96
93
|
#
|
|
97
94
|
# If a queue is paused then the system will stop dispatching tasks
|
|
98
95
|
# until the queue is resumed via
|
|
99
|
-
# [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue]. Tasks can
|
|
100
|
-
#
|
|
101
|
-
# [state][google.cloud.tasks.v2beta3.Queue.state] is
|
|
102
|
-
# [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED].
|
|
96
|
+
# [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue]. Tasks can still be added
|
|
97
|
+
# when the queue is paused. A queue is paused if its
|
|
98
|
+
# [state][google.cloud.tasks.v2beta3.Queue.state] is [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED].
|
|
103
99
|
rpc :PauseQueue, PauseQueueRequest, Queue
|
|
104
100
|
# Resume a queue.
|
|
105
101
|
#
|
|
106
102
|
# This method resumes a queue after it has been
|
|
107
103
|
# [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED] or
|
|
108
|
-
# [DISABLED][google.cloud.tasks.v2beta3.Queue.State.DISABLED]. The state of a
|
|
109
|
-
#
|
|
110
|
-
# [
|
|
111
|
-
# it will be set to
|
|
112
|
-
# [RUNNING][google.cloud.tasks.v2beta3.Queue.State.RUNNING].
|
|
104
|
+
# [DISABLED][google.cloud.tasks.v2beta3.Queue.State.DISABLED]. The state of a queue is stored
|
|
105
|
+
# in the queue's [state][google.cloud.tasks.v2beta3.Queue.state]; after calling this method it
|
|
106
|
+
# will be set to [RUNNING][google.cloud.tasks.v2beta3.Queue.State.RUNNING].
|
|
113
107
|
#
|
|
114
108
|
# WARNING: Resuming many high-QPS queues at the same time can
|
|
115
109
|
# lead to target overloading. If you are resuming high-QPS
|
|
116
110
|
# queues, follow the 500/50/5 pattern described in
|
|
117
|
-
# [Managing Cloud Tasks Scaling
|
|
118
|
-
# Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
|
|
111
|
+
# [Managing Cloud Tasks Scaling Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
|
|
119
112
|
rpc :ResumeQueue, ResumeQueueRequest, Queue
|
|
120
|
-
# Gets the access control policy for a
|
|
121
|
-
#
|
|
122
|
-
#
|
|
113
|
+
# Gets the access control policy for a [Queue][google.cloud.tasks.v2beta3.Queue].
|
|
114
|
+
# Returns an empty policy if the resource exists and does not have a policy
|
|
115
|
+
# set.
|
|
123
116
|
#
|
|
124
117
|
# Authorization requires the following
|
|
125
118
|
# [Google IAM](https://cloud.google.com/iam) permission on the specified
|
|
@@ -127,8 +120,8 @@ module Google
|
|
|
127
120
|
#
|
|
128
121
|
# * `cloudtasks.queues.getIamPolicy`
|
|
129
122
|
rpc :GetIamPolicy, Google::Iam::V1::GetIamPolicyRequest, Google::Iam::V1::Policy
|
|
130
|
-
# Sets the access control policy for a
|
|
131
|
-
#
|
|
123
|
+
# Sets the access control policy for a [Queue][google.cloud.tasks.v2beta3.Queue]. Replaces any existing
|
|
124
|
+
# policy.
|
|
132
125
|
#
|
|
133
126
|
# Note: The Cloud Console does not check queue-level IAM permissions yet.
|
|
134
127
|
# Project-level permissions are required to use the Cloud Console.
|
|
@@ -139,10 +132,9 @@ module Google
|
|
|
139
132
|
#
|
|
140
133
|
# * `cloudtasks.queues.setIamPolicy`
|
|
141
134
|
rpc :SetIamPolicy, Google::Iam::V1::SetIamPolicyRequest, Google::Iam::V1::Policy
|
|
142
|
-
# Returns permissions that a caller has on a
|
|
143
|
-
#
|
|
144
|
-
#
|
|
145
|
-
# [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
|
|
135
|
+
# Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2beta3.Queue].
|
|
136
|
+
# If the resource does not exist, this will return an empty set of
|
|
137
|
+
# permissions, not a [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
|
|
146
138
|
#
|
|
147
139
|
# Note: This operation is designed to be used for building permission-aware
|
|
148
140
|
# UIs and command-line tools, not for authorization checking. This operation
|
|
@@ -150,10 +142,10 @@ module Google
|
|
|
150
142
|
rpc :TestIamPermissions, Google::Iam::V1::TestIamPermissionsRequest, Google::Iam::V1::TestIamPermissionsResponse
|
|
151
143
|
# Lists the tasks in a queue.
|
|
152
144
|
#
|
|
153
|
-
# By default, only the [BASIC][google.cloud.tasks.v2beta3.Task.View.BASIC]
|
|
154
|
-
#
|
|
155
|
-
# [response_view][google.cloud.tasks.v2beta3.ListTasksRequest.response_view]
|
|
156
|
-
#
|
|
145
|
+
# By default, only the [BASIC][google.cloud.tasks.v2beta3.Task.View.BASIC] view is retrieved
|
|
146
|
+
# due to performance considerations;
|
|
147
|
+
# [response_view][google.cloud.tasks.v2beta3.ListTasksRequest.response_view] controls the
|
|
148
|
+
# subset of information which is returned.
|
|
157
149
|
#
|
|
158
150
|
# The tasks may be returned in any order. The ordering may change at any
|
|
159
151
|
# time.
|
|
@@ -164,8 +156,7 @@ module Google
|
|
|
164
156
|
#
|
|
165
157
|
# Tasks cannot be updated after creation; there is no UpdateTask command.
|
|
166
158
|
#
|
|
167
|
-
# * For [App Engine queues][google.cloud.tasks.v2beta3.AppEngineHttpQueue],
|
|
168
|
-
# the maximum task size is
|
|
159
|
+
# * For [App Engine queues][google.cloud.tasks.v2beta3.AppEngineHttpQueue], the maximum task size is
|
|
169
160
|
# 100KB.
|
|
170
161
|
rpc :CreateTask, CreateTaskRequest, Task
|
|
171
162
|
# Deletes a task.
|
|
@@ -177,14 +168,13 @@ module Google
|
|
|
177
168
|
# Forces a task to run now.
|
|
178
169
|
#
|
|
179
170
|
# When this method is called, Cloud Tasks will dispatch the task, even if
|
|
180
|
-
# the task is already running, the queue has reached its
|
|
181
|
-
# [
|
|
182
|
-
# [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED].
|
|
171
|
+
# the task is already running, the queue has reached its [RateLimits][google.cloud.tasks.v2beta3.RateLimits] or
|
|
172
|
+
# is [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED].
|
|
183
173
|
#
|
|
184
174
|
# This command is meant to be used for manual debugging. For
|
|
185
|
-
# example, [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask] can be
|
|
186
|
-
#
|
|
187
|
-
#
|
|
175
|
+
# example, [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask] can be used to retry a failed
|
|
176
|
+
# task after a fix has been made or to manually force a task to be
|
|
177
|
+
# dispatched now.
|
|
188
178
|
#
|
|
189
179
|
# The dispatched task is returned. That is, the task that is returned
|
|
190
180
|
# contains the [status][Task.status] after the task is dispatched but
|
|
@@ -192,11 +182,9 @@ module Google
|
|
|
192
182
|
#
|
|
193
183
|
# If Cloud Tasks receives a successful response from the task's
|
|
194
184
|
# target, then the task will be deleted; otherwise the task's
|
|
195
|
-
# [schedule_time][google.cloud.tasks.v2beta3.Task.schedule_time] will be
|
|
196
|
-
#
|
|
197
|
-
# [
|
|
198
|
-
# the retry delay specified in the queue's
|
|
199
|
-
# [RetryConfig][google.cloud.tasks.v2beta3.RetryConfig].
|
|
185
|
+
# [schedule_time][google.cloud.tasks.v2beta3.Task.schedule_time] will be reset to the time that
|
|
186
|
+
# [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask] was called plus the retry delay specified
|
|
187
|
+
# in the queue's [RetryConfig][google.cloud.tasks.v2beta3.RetryConfig].
|
|
200
188
|
#
|
|
201
189
|
# [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask] returns
|
|
202
190
|
# [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
|