google-cloud-tasks 0.2.3 → 0.2.4
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/README.md +5 -5
- data/lib/google/cloud/tasks.rb +4 -4
- data/lib/google/cloud/tasks/v2beta2.rb +4 -4
- data/lib/google/cloud/tasks/v2beta2/cloud_tasks_client.rb +61 -61
- data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/cloudtasks.rb +38 -38
- data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/queue.rb +25 -25
- data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/target.rb +42 -42
- data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/task.rb +11 -11
- data/lib/google/cloud/tasks/v2beta2/doc/google/iam/v1/iam_policy.rb +13 -13
- data/lib/google/cloud/tasks/v2beta2/doc/google/iam/v1/policy.rb +28 -28
- data/lib/google/cloud/tasks/v2beta2/doc/google/protobuf/any.rb +8 -8
- data/lib/google/cloud/tasks/v2beta2/doc/google/protobuf/duration.rb +3 -3
- data/lib/google/cloud/tasks/v2beta2/doc/google/protobuf/empty.rb +1 -1
- data/lib/google/cloud/tasks/v2beta2/doc/google/protobuf/field_mask.rb +7 -7
- data/lib/google/cloud/tasks/v2beta2/doc/google/protobuf/timestamp.rb +7 -7
- data/lib/google/cloud/tasks/v2beta2/doc/google/rpc/status.rb +11 -11
- metadata +3 -4
- data/lib/google/cloud/tasks/v2beta2/doc/overview.rb +0 -80
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3ee6dbc8ed476d3f292086826021a078ec949d53be94ee3dcd8e19d17415a915
|
4
|
+
data.tar.gz: 4fec489cfedc5b312a13b58789e20ad05fc45f9b86251d0dae0b3ddf3a9fe9a4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 837de041e784e4a614f6d76f2cfabebac1362d348bbd6c4680cc3dc2644fbb6133c27f1be67152af52de13e3c6006f72207b6a40c541b82d3d68306b145b1bd3
|
7
|
+
data.tar.gz: 3a2cc0e991feb4f61b64a893416b0e137e1ec069dc44686a10a62437502a4c654b8d7d19ccc80243bb7963c749805a79917cc3445858ab568082fc29b6e462c9
|
data/README.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
# Ruby Client for Cloud Tasks API ([Alpha](https://github.com/
|
1
|
+
# Ruby Client for Cloud Tasks API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
|
2
2
|
|
3
3
|
[Cloud Tasks API][Product Documentation]:
|
4
4
|
Manages the execution of large numbers of distributed requests.
|
@@ -12,7 +12,7 @@ steps:
|
|
12
12
|
1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
|
13
13
|
2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
|
14
14
|
3. [Enable the Cloud Tasks API.](https://console.cloud.google.com/apis/library/tasks.googleapis.com)
|
15
|
-
4. [Setup Authentication.](https://
|
15
|
+
4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
|
16
16
|
|
17
17
|
### Installation
|
18
18
|
```
|
@@ -24,17 +24,17 @@ $ gem install google-cloud-tasks
|
|
24
24
|
to see other available methods on the client.
|
25
25
|
- Read the [Cloud Tasks API Product documentation][Product Documentation]
|
26
26
|
to learn more about the product and see How-to Guides.
|
27
|
-
- View this [repository's main README](https://github.com/
|
27
|
+
- View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
|
28
28
|
to see the full list of Cloud APIs that we cover.
|
29
29
|
|
30
|
-
[Client Library Documentation]: https://
|
30
|
+
[Client Library Documentation]: https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-tasks/latest/google/cloud/tasks/v2beta2
|
31
31
|
[Product Documentation]: https://cloud.google.com/tasks
|
32
32
|
|
33
33
|
## Enabling Logging
|
34
34
|
|
35
35
|
To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
|
36
36
|
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,
|
37
|
-
or a [`Google::Cloud::Logging::Logger`](https://
|
37
|
+
or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
|
38
38
|
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)
|
39
39
|
and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
|
40
40
|
|
data/lib/google/cloud/tasks.rb
CHANGED
@@ -21,7 +21,7 @@ module Google
|
|
21
21
|
# rubocop:disable LineLength
|
22
22
|
|
23
23
|
##
|
24
|
-
# # Ruby Client for Cloud Tasks API ([Alpha](https://github.com/
|
24
|
+
# # Ruby Client for Cloud Tasks API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
|
25
25
|
#
|
26
26
|
# [Cloud Tasks API][Product Documentation]:
|
27
27
|
# Manages the execution of large numbers of distributed requests.
|
@@ -34,7 +34,7 @@ module Google
|
|
34
34
|
# 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
|
35
35
|
# 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
|
36
36
|
# 3. [Enable the Cloud Tasks API.](https://console.cloud.google.com/apis/library/tasks.googleapis.com)
|
37
|
-
# 4. [Setup Authentication.](https://
|
37
|
+
# 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
|
38
38
|
#
|
39
39
|
# ### Installation
|
40
40
|
# ```
|
@@ -44,7 +44,7 @@ module Google
|
|
44
44
|
# ### Next Steps
|
45
45
|
# - Read the [Cloud Tasks API Product documentation][Product Documentation]
|
46
46
|
# to learn more about the product and see How-to Guides.
|
47
|
-
# - View this [repository's main README](https://github.com/
|
47
|
+
# - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
|
48
48
|
# to see the full list of Cloud APIs that we cover.
|
49
49
|
#
|
50
50
|
# [Product Documentation]: https://cloud.google.com/tasks
|
@@ -53,7 +53,7 @@ module Google
|
|
53
53
|
#
|
54
54
|
# To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
|
55
55
|
# 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,
|
56
|
-
# or a [`Google::Cloud::Logging::Logger`](https://
|
56
|
+
# or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
|
57
57
|
# 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)
|
58
58
|
# and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
|
59
59
|
#
|
@@ -21,7 +21,7 @@ module Google
|
|
21
21
|
# rubocop:disable LineLength
|
22
22
|
|
23
23
|
##
|
24
|
-
# # Ruby Client for Cloud Tasks API ([Alpha](https://github.com/
|
24
|
+
# # Ruby Client for Cloud Tasks API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
|
25
25
|
#
|
26
26
|
# [Cloud Tasks API][Product Documentation]:
|
27
27
|
# Manages the execution of large numbers of distributed requests.
|
@@ -34,7 +34,7 @@ module Google
|
|
34
34
|
# 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
|
35
35
|
# 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
|
36
36
|
# 3. [Enable the Cloud Tasks API.](https://console.cloud.google.com/apis/library/tasks.googleapis.com)
|
37
|
-
# 4. [Setup Authentication.](https://
|
37
|
+
# 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
|
38
38
|
#
|
39
39
|
# ### Installation
|
40
40
|
# ```
|
@@ -44,7 +44,7 @@ module Google
|
|
44
44
|
# ### Next Steps
|
45
45
|
# - Read the [Cloud Tasks API Product documentation][Product Documentation]
|
46
46
|
# to learn more about the product and see How-to Guides.
|
47
|
-
# - View this [repository's main README](https://github.com/
|
47
|
+
# - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
|
48
48
|
# to see the full list of Cloud APIs that we cover.
|
49
49
|
#
|
50
50
|
# [Product Documentation]: https://cloud.google.com/tasks
|
@@ -53,7 +53,7 @@ module Google
|
|
53
53
|
#
|
54
54
|
# To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
|
55
55
|
# 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,
|
56
|
-
# or a [`Google::Cloud::Logging::Logger`](https://
|
56
|
+
# or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
|
57
57
|
# 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)
|
58
58
|
# and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
|
59
59
|
#
|
@@ -419,11 +419,11 @@ module Google
|
|
419
419
|
# Required.
|
420
420
|
#
|
421
421
|
# The location name.
|
422
|
-
# For example:
|
422
|
+
# For example: `projects/PROJECT_ID/locations/LOCATION_ID`
|
423
423
|
# @param filter [String]
|
424
|
-
#
|
424
|
+
# `filter` can be used to specify a subset of queues. Any {Google::Cloud::Tasks::V2beta2::Queue Queue}
|
425
425
|
# field can be used as a filter and several operators as supported.
|
426
|
-
# For example:
|
426
|
+
# For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
|
427
427
|
# described in
|
428
428
|
# [Stackdriver's Advanced Logs Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
|
429
429
|
#
|
@@ -489,7 +489,7 @@ module Google
|
|
489
489
|
# Required.
|
490
490
|
#
|
491
491
|
# The resource name of the queue. For example:
|
492
|
-
#
|
492
|
+
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
493
493
|
# @param options [Google::Gax::CallOptions]
|
494
494
|
# Overrides the default settings for this call, e.g, timeout,
|
495
495
|
# retries, etc.
|
@@ -523,7 +523,7 @@ module Google
|
|
523
523
|
# it was dispatched or not.
|
524
524
|
#
|
525
525
|
# WARNING: Using this method may have unintended side effects if you are
|
526
|
-
# using an App Engine
|
526
|
+
# using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
|
527
527
|
# Read
|
528
528
|
# [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
|
529
529
|
# before using this method.
|
@@ -532,7 +532,7 @@ module Google
|
|
532
532
|
# Required.
|
533
533
|
#
|
534
534
|
# The location name in which the queue will be created.
|
535
|
-
# For example:
|
535
|
+
# For example: `projects/PROJECT_ID/locations/LOCATION_ID`
|
536
536
|
#
|
537
537
|
# The list of allowed locations can be obtained by calling Cloud
|
538
538
|
# Tasks' implementation of
|
@@ -559,7 +559,7 @@ module Google
|
|
559
559
|
# cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
|
560
560
|
# formatted_parent = Google::Cloud::Tasks::V2beta2::CloudTasksClient.location_path("[PROJECT]", "[LOCATION]")
|
561
561
|
#
|
562
|
-
# # TODO: Initialize
|
562
|
+
# # TODO: Initialize `queue`:
|
563
563
|
# queue = {}
|
564
564
|
# response = cloud_tasks_client.create_queue(formatted_parent, queue)
|
565
565
|
|
@@ -586,7 +586,7 @@ module Google
|
|
586
586
|
# it was dispatched or not.
|
587
587
|
#
|
588
588
|
# WARNING: Using this method may have unintended side effects if you are
|
589
|
-
# using an App Engine
|
589
|
+
# using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
|
590
590
|
# Read
|
591
591
|
# [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
|
592
592
|
# before using this method.
|
@@ -622,7 +622,7 @@ module Google
|
|
622
622
|
#
|
623
623
|
# cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
|
624
624
|
#
|
625
|
-
# # TODO: Initialize
|
625
|
+
# # TODO: Initialize `queue`:
|
626
626
|
# queue = {}
|
627
627
|
# response = cloud_tasks_client.update_queue(queue)
|
628
628
|
|
@@ -647,7 +647,7 @@ module Google
|
|
647
647
|
# for 7 days.
|
648
648
|
#
|
649
649
|
# WARNING: Using this method may have unintended side effects if you are
|
650
|
-
# using an App Engine
|
650
|
+
# using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
|
651
651
|
# Read
|
652
652
|
# [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
|
653
653
|
# before using this method.
|
@@ -656,7 +656,7 @@ module Google
|
|
656
656
|
# Required.
|
657
657
|
#
|
658
658
|
# The queue name. For example:
|
659
|
-
#
|
659
|
+
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
660
660
|
# @param options [Google::Gax::CallOptions]
|
661
661
|
# Overrides the default settings for this call, e.g, timeout,
|
662
662
|
# retries, etc.
|
@@ -694,7 +694,7 @@ module Google
|
|
694
694
|
# Required.
|
695
695
|
#
|
696
696
|
# The queue name. For example:
|
697
|
-
#
|
697
|
+
# `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
|
698
698
|
# @param options [Google::Gax::CallOptions]
|
699
699
|
# Overrides the default settings for this call, e.g, timeout,
|
700
700
|
# retries, etc.
|
@@ -733,7 +733,7 @@ module Google
|
|
733
733
|
# Required.
|
734
734
|
#
|
735
735
|
# The queue name. For example:
|
736
|
-
#
|
736
|
+
# `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
|
737
737
|
# @param options [Google::Gax::CallOptions]
|
738
738
|
# Overrides the default settings for this call, e.g, timeout,
|
739
739
|
# retries, etc.
|
@@ -777,7 +777,7 @@ module Google
|
|
777
777
|
# Required.
|
778
778
|
#
|
779
779
|
# The queue name. For example:
|
780
|
-
#
|
780
|
+
# `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
|
781
781
|
# @param options [Google::Gax::CallOptions]
|
782
782
|
# Overrides the default settings for this call, e.g, timeout,
|
783
783
|
# retries, etc.
|
@@ -812,12 +812,12 @@ module Google
|
|
812
812
|
# [Google IAM](https://cloud.google.com/iam) permission on the specified
|
813
813
|
# resource parent:
|
814
814
|
#
|
815
|
-
# *
|
815
|
+
# * `cloudtasks.queues.getIamPolicy`
|
816
816
|
#
|
817
817
|
# @param resource [String]
|
818
818
|
# REQUIRED: The resource for which the policy is being requested.
|
819
|
-
#
|
820
|
-
# resource is specified as
|
819
|
+
# `resource` is usually specified as a path. For example, a Project
|
820
|
+
# resource is specified as `projects/{project}`.
|
821
821
|
# @param options [Google::Gax::CallOptions]
|
822
822
|
# Overrides the default settings for this call, e.g, timeout,
|
823
823
|
# retries, etc.
|
@@ -854,14 +854,14 @@ module Google
|
|
854
854
|
# [Google IAM](https://cloud.google.com/iam) permission on the specified
|
855
855
|
# resource parent:
|
856
856
|
#
|
857
|
-
# *
|
857
|
+
# * `cloudtasks.queues.setIamPolicy`
|
858
858
|
#
|
859
859
|
# @param resource [String]
|
860
860
|
# REQUIRED: The resource for which the policy is being specified.
|
861
|
-
#
|
862
|
-
# resource is specified as
|
861
|
+
# `resource` is usually specified as a path. For example, a Project
|
862
|
+
# resource is specified as `projects/{project}`.
|
863
863
|
# @param policy [Google::Iam::V1::Policy | Hash]
|
864
|
-
# REQUIRED: The complete policy to be applied to the
|
864
|
+
# REQUIRED: The complete policy to be applied to the `resource`. The size of
|
865
865
|
# the policy is limited to a few 10s of KB. An empty policy is a
|
866
866
|
# valid policy but certain Cloud Platform services (such as Projects)
|
867
867
|
# might reject them.
|
@@ -881,7 +881,7 @@ module Google
|
|
881
881
|
# cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
|
882
882
|
# formatted_resource = Google::Cloud::Tasks::V2beta2::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
|
883
883
|
#
|
884
|
-
# # TODO: Initialize
|
884
|
+
# # TODO: Initialize `policy`:
|
885
885
|
# policy = {}
|
886
886
|
# response = cloud_tasks_client.set_iam_policy(formatted_resource, policy)
|
887
887
|
|
@@ -908,10 +908,10 @@ module Google
|
|
908
908
|
#
|
909
909
|
# @param resource [String]
|
910
910
|
# REQUIRED: The resource for which the policy detail is being requested.
|
911
|
-
#
|
912
|
-
# resource is specified as
|
911
|
+
# `resource` is usually specified as a path. For example, a Project
|
912
|
+
# resource is specified as `projects/{project}`.
|
913
913
|
# @param permissions [Array<String>]
|
914
|
-
# The set of permissions to check for the
|
914
|
+
# The set of permissions to check for the `resource`. Permissions with
|
915
915
|
# wildcards (such as '*' or 'storage.*') are not allowed. For more
|
916
916
|
# information see
|
917
917
|
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
|
@@ -929,7 +929,7 @@ module Google
|
|
929
929
|
# cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
|
930
930
|
# formatted_resource = Google::Cloud::Tasks::V2beta2::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
|
931
931
|
#
|
932
|
-
# # TODO: Initialize
|
932
|
+
# # TODO: Initialize `permissions`:
|
933
933
|
# permissions = []
|
934
934
|
# response = cloud_tasks_client.test_iam_permissions(formatted_resource, permissions)
|
935
935
|
|
@@ -960,7 +960,7 @@ module Google
|
|
960
960
|
# Required.
|
961
961
|
#
|
962
962
|
# The queue name. For example:
|
963
|
-
#
|
963
|
+
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
964
964
|
# @param response_view [Google::Cloud::Tasks::V2beta2::Task::View]
|
965
965
|
# The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta2::Task Task} will be
|
966
966
|
# returned.
|
@@ -972,7 +972,7 @@ module Google
|
|
972
972
|
# contains.
|
973
973
|
#
|
974
974
|
# Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
|
975
|
-
#
|
975
|
+
# `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
|
976
976
|
# permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
|
977
977
|
# @param page_size [Integer]
|
978
978
|
# The maximum number of resources contained in the underlying API
|
@@ -1032,7 +1032,7 @@ module Google
|
|
1032
1032
|
# Required.
|
1033
1033
|
#
|
1034
1034
|
# The task name. For example:
|
1035
|
-
#
|
1035
|
+
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
1036
1036
|
# @param response_view [Google::Cloud::Tasks::V2beta2::Task::View]
|
1037
1037
|
# The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta2::Task Task} will be
|
1038
1038
|
# returned.
|
@@ -1044,7 +1044,7 @@ module Google
|
|
1044
1044
|
# contains.
|
1045
1045
|
#
|
1046
1046
|
# Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
|
1047
|
-
#
|
1047
|
+
# `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
|
1048
1048
|
# permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
|
1049
1049
|
# @param options [Google::Gax::CallOptions]
|
1050
1050
|
# Overrides the default settings for this call, e.g, timeout,
|
@@ -1086,7 +1086,7 @@ module Google
|
|
1086
1086
|
# Required.
|
1087
1087
|
#
|
1088
1088
|
# The queue name. For example:
|
1089
|
-
#
|
1089
|
+
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
1090
1090
|
#
|
1091
1091
|
# The queue must already exist.
|
1092
1092
|
# @param task [Google::Cloud::Tasks::V2beta2::Task | Hash]
|
@@ -1095,7 +1095,7 @@ module Google
|
|
1095
1095
|
# The task to add.
|
1096
1096
|
#
|
1097
1097
|
# Task names have the following format:
|
1098
|
-
#
|
1098
|
+
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
|
1099
1099
|
# The user can optionally specify a task {Google::Cloud::Tasks::V2beta2::Task#name name}. If a
|
1100
1100
|
# name is not specified then the system will generate a random
|
1101
1101
|
# unique task id, which will be set in the task returned in the
|
@@ -1138,7 +1138,7 @@ module Google
|
|
1138
1138
|
# contains.
|
1139
1139
|
#
|
1140
1140
|
# Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
|
1141
|
-
#
|
1141
|
+
# `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
|
1142
1142
|
# permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
|
1143
1143
|
# @param options [Google::Gax::CallOptions]
|
1144
1144
|
# Overrides the default settings for this call, e.g, timeout,
|
@@ -1154,7 +1154,7 @@ module Google
|
|
1154
1154
|
# cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
|
1155
1155
|
# formatted_parent = Google::Cloud::Tasks::V2beta2::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
|
1156
1156
|
#
|
1157
|
-
# # TODO: Initialize
|
1157
|
+
# # TODO: Initialize `task`:
|
1158
1158
|
# task = {}
|
1159
1159
|
# response = cloud_tasks_client.create_task(formatted_parent, task)
|
1160
1160
|
|
@@ -1183,7 +1183,7 @@ module Google
|
|
1183
1183
|
# Required.
|
1184
1184
|
#
|
1185
1185
|
# The task name. For example:
|
1186
|
-
#
|
1186
|
+
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
1187
1187
|
# @param options [Google::Gax::CallOptions]
|
1188
1188
|
# Overrides the default settings for this call, e.g, timeout,
|
1189
1189
|
# retries, etc.
|
@@ -1237,7 +1237,7 @@ module Google
|
|
1237
1237
|
# Required.
|
1238
1238
|
#
|
1239
1239
|
# The queue name. For example:
|
1240
|
-
#
|
1240
|
+
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
1241
1241
|
# @param lease_duration [Google::Protobuf::Duration | Hash]
|
1242
1242
|
# After the worker has successfully finished the work associated
|
1243
1243
|
# with the task, the worker must call via
|
@@ -1247,16 +1247,16 @@ module Google
|
|
1247
1247
|
# that another worker can retry it.
|
1248
1248
|
#
|
1249
1249
|
# The maximum lease duration is 1 week.
|
1250
|
-
#
|
1250
|
+
# `lease_duration` will be truncated to the nearest second.
|
1251
1251
|
# A hash of the same form as `Google::Protobuf::Duration`
|
1252
1252
|
# can also be provided.
|
1253
1253
|
# @param max_tasks [Integer]
|
1254
1254
|
# The maximum number of tasks to lease.
|
1255
1255
|
#
|
1256
1256
|
# The system will make a best effort to return as close to as
|
1257
|
-
#
|
1257
|
+
# `max_tasks` as possible.
|
1258
1258
|
#
|
1259
|
-
# The largest that
|
1259
|
+
# The largest that `max_tasks` can be is 1000.
|
1260
1260
|
# @param response_view [Google::Cloud::Tasks::V2beta2::Task::View]
|
1261
1261
|
# The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta2::Task Task} will be
|
1262
1262
|
# returned.
|
@@ -1268,29 +1268,29 @@ module Google
|
|
1268
1268
|
# contains.
|
1269
1269
|
#
|
1270
1270
|
# Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
|
1271
|
-
#
|
1271
|
+
# `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
|
1272
1272
|
# permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
|
1273
1273
|
# @param filter [String]
|
1274
|
-
#
|
1274
|
+
# `filter` can be used to specify a subset of tasks to lease.
|
1275
1275
|
#
|
1276
|
-
# When
|
1276
|
+
# When `filter` is set to `tag=<my-tag>` then the
|
1277
1277
|
# {Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will contain only tasks whose
|
1278
|
-
# {Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} is equal to
|
1278
|
+
# {Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} is equal to `<my-tag>`. `<my-tag>` must be
|
1279
1279
|
# less than 500 characters.
|
1280
1280
|
#
|
1281
|
-
# When
|
1281
|
+
# When `filter` is set to `tag_function=oldest_tag()`, only tasks which have
|
1282
1282
|
# the same tag as the task with the oldest
|
1283
1283
|
# {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be returned.
|
1284
1284
|
#
|
1285
1285
|
# Grammar Syntax:
|
1286
1286
|
#
|
1287
|
-
# *
|
1287
|
+
# * `filter = "tag=" tag | "tag_function=" function`
|
1288
1288
|
#
|
1289
|
-
# *
|
1289
|
+
# * `tag = string`
|
1290
1290
|
#
|
1291
|
-
# *
|
1291
|
+
# * `function = "oldest_tag()"`
|
1292
1292
|
#
|
1293
|
-
# The
|
1293
|
+
# The `oldest_tag()` function returns tasks which have the same tag as the
|
1294
1294
|
# oldest task (ordered by schedule time).
|
1295
1295
|
#
|
1296
1296
|
# SDK compatibility: Although the SDK allows tags to be either
|
@@ -1314,7 +1314,7 @@ module Google
|
|
1314
1314
|
# cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
|
1315
1315
|
# formatted_parent = Google::Cloud::Tasks::V2beta2::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
|
1316
1316
|
#
|
1317
|
-
# # TODO: Initialize
|
1317
|
+
# # TODO: Initialize `lease_duration`:
|
1318
1318
|
# lease_duration = {}
|
1319
1319
|
# response = cloud_tasks_client.lease_tasks(formatted_parent, lease_duration)
|
1320
1320
|
|
@@ -1355,7 +1355,7 @@ module Google
|
|
1355
1355
|
# Required.
|
1356
1356
|
#
|
1357
1357
|
# The task name. For example:
|
1358
|
-
#
|
1358
|
+
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
1359
1359
|
# @param schedule_time [Google::Protobuf::Timestamp | Hash]
|
1360
1360
|
# Required.
|
1361
1361
|
#
|
@@ -1379,7 +1379,7 @@ module Google
|
|
1379
1379
|
# cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
|
1380
1380
|
# formatted_name = Google::Cloud::Tasks::V2beta2::CloudTasksClient.task_path("[PROJECT]", "[LOCATION]", "[QUEUE]", "[TASK]")
|
1381
1381
|
#
|
1382
|
-
# # TODO: Initialize
|
1382
|
+
# # TODO: Initialize `schedule_time`:
|
1383
1383
|
# schedule_time = {}
|
1384
1384
|
# cloud_tasks_client.acknowledge_task(formatted_name, schedule_time)
|
1385
1385
|
|
@@ -1407,7 +1407,7 @@ module Google
|
|
1407
1407
|
# Required.
|
1408
1408
|
#
|
1409
1409
|
# The task name. For example:
|
1410
|
-
#
|
1410
|
+
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
1411
1411
|
# @param schedule_time [Google::Protobuf::Timestamp | Hash]
|
1412
1412
|
# Required.
|
1413
1413
|
#
|
@@ -1425,7 +1425,7 @@ module Google
|
|
1425
1425
|
#
|
1426
1426
|
#
|
1427
1427
|
# The maximum lease duration is 1 week.
|
1428
|
-
#
|
1428
|
+
# `lease_duration` will be truncated to the nearest second.
|
1429
1429
|
# A hash of the same form as `Google::Protobuf::Duration`
|
1430
1430
|
# can also be provided.
|
1431
1431
|
# @param response_view [Google::Cloud::Tasks::V2beta2::Task::View]
|
@@ -1439,7 +1439,7 @@ module Google
|
|
1439
1439
|
# contains.
|
1440
1440
|
#
|
1441
1441
|
# Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
|
1442
|
-
#
|
1442
|
+
# `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
|
1443
1443
|
# permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
|
1444
1444
|
# @param options [Google::Gax::CallOptions]
|
1445
1445
|
# Overrides the default settings for this call, e.g, timeout,
|
@@ -1455,10 +1455,10 @@ module Google
|
|
1455
1455
|
# cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
|
1456
1456
|
# formatted_name = Google::Cloud::Tasks::V2beta2::CloudTasksClient.task_path("[PROJECT]", "[LOCATION]", "[QUEUE]", "[TASK]")
|
1457
1457
|
#
|
1458
|
-
# # TODO: Initialize
|
1458
|
+
# # TODO: Initialize `schedule_time`:
|
1459
1459
|
# schedule_time = {}
|
1460
1460
|
#
|
1461
|
-
# # TODO: Initialize
|
1461
|
+
# # TODO: Initialize `lease_duration`:
|
1462
1462
|
# lease_duration = {}
|
1463
1463
|
# response = cloud_tasks_client.renew_lease(formatted_name, schedule_time, lease_duration)
|
1464
1464
|
|
@@ -1490,7 +1490,7 @@ module Google
|
|
1490
1490
|
# Required.
|
1491
1491
|
#
|
1492
1492
|
# The task name. For example:
|
1493
|
-
#
|
1493
|
+
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
1494
1494
|
# @param schedule_time [Google::Protobuf::Timestamp | Hash]
|
1495
1495
|
# Required.
|
1496
1496
|
#
|
@@ -1512,7 +1512,7 @@ module Google
|
|
1512
1512
|
# contains.
|
1513
1513
|
#
|
1514
1514
|
# Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
|
1515
|
-
#
|
1515
|
+
# `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
|
1516
1516
|
# permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
|
1517
1517
|
# @param options [Google::Gax::CallOptions]
|
1518
1518
|
# Overrides the default settings for this call, e.g, timeout,
|
@@ -1528,7 +1528,7 @@ module Google
|
|
1528
1528
|
# cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
|
1529
1529
|
# formatted_name = Google::Cloud::Tasks::V2beta2::CloudTasksClient.task_path("[PROJECT]", "[LOCATION]", "[QUEUE]", "[TASK]")
|
1530
1530
|
#
|
1531
|
-
# # TODO: Initialize
|
1531
|
+
# # TODO: Initialize `schedule_time`:
|
1532
1532
|
# schedule_time = {}
|
1533
1533
|
# response = cloud_tasks_client.cancel_lease(formatted_name, schedule_time)
|
1534
1534
|
|
@@ -1579,7 +1579,7 @@ module Google
|
|
1579
1579
|
# Required.
|
1580
1580
|
#
|
1581
1581
|
# The task name. For example:
|
1582
|
-
#
|
1582
|
+
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
1583
1583
|
# @param response_view [Google::Cloud::Tasks::V2beta2::Task::View]
|
1584
1584
|
# The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta2::Task Task} will be
|
1585
1585
|
# returned.
|
@@ -1591,7 +1591,7 @@ module Google
|
|
1591
1591
|
# contains.
|
1592
1592
|
#
|
1593
1593
|
# Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
|
1594
|
-
#
|
1594
|
+
# `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
|
1595
1595
|
# permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
|
1596
1596
|
# @param options [Google::Gax::CallOptions]
|
1597
1597
|
# Overrides the default settings for this call, e.g, timeout,
|