google-cloud-tasks 0.2.1 → 0.2.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (15) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +1 -0
  3. data/README.md +1 -1
  4. data/lib/google/cloud/tasks.rb +33 -4
  5. data/lib/google/cloud/tasks/v2beta2.rb +52 -52
  6. data/lib/google/cloud/tasks/v2beta2/cloud_tasks_client.rb +70 -73
  7. data/lib/google/cloud/tasks/v2beta2/cloudtasks_pb.rb +0 -1
  8. data/lib/google/cloud/tasks/v2beta2/cloudtasks_services_pb.rb +17 -13
  9. data/lib/google/cloud/tasks/v2beta2/credentials.rb +10 -2
  10. data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/cloudtasks.rb +14 -31
  11. data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/queue.rb +14 -19
  12. data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/target.rb +7 -7
  13. data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/task.rb +3 -6
  14. data/lib/google/cloud/tasks/v2beta2/doc/overview.rb +1 -1
  15. metadata +31 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 25f4cbac72df3d1e7b82550d8e350b959abc54da26ba23b44e3c694506b2b0ff
4
- data.tar.gz: f28399518d68eb49196c3ba2f360542b30b4b8dd5a5b0f0bd0aaaaf8842e1086
3
+ metadata.gz: b43105207af0e33d28dc9c10e274d5e85e7c880a5347b2328f5e58b321313f09
4
+ data.tar.gz: 8b8ce7bf133ffd14cf83d02a704e354eba539b6ea024854d885fa598884676ee
5
5
  SHA512:
6
- metadata.gz: a9c2f438ca71700db2a4bf78fad83e3b3e39d4b10a8ca022ecae293f0ab526e9b268437849df120273006677b2f89041f8676740de280fce643f17ac55f9936b
7
- data.tar.gz: 10fbc08e6b87e05e9037d2df71c5ad1174c44158c572e9661656e4a71386b3026ac5fe0446c6990027cfdbb9b5249c9ea0302c74910bf56ddae9c91c6e33a6e7
6
+ metadata.gz: 86b282bd95bfd66a3bdee6e8e96842cc5fce1ba0ad4a95666b48f1d18ec1253fa7df34db739f4bb64db8bc16909651e8539a1cd3cc647e7789604571260de8ab
7
+ data.tar.gz: 74dbd22ff1743dde0c40d8fd819109b66b1f9cfebfb109e25f6996f277a3d50f9282176371f773a9aae0e851fefa09621cee7962d9f9f779c8f3c9fa8d281908
data/.yardopts CHANGED
@@ -2,6 +2,7 @@
2
2
  --title=Cloud Tasks API
3
3
  --exclude _pb\.rb$
4
4
  --markup markdown
5
+ --markup-provider redcarpet
5
6
 
6
7
  ./lib/**/*.rb
7
8
  -
data/README.md CHANGED
@@ -11,7 +11,7 @@ steps:
11
11
 
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
- 3. [Enable the Cloud Tasks API.](https://console.cloud.google.com/apis/api/tasks)
14
+ 3. [Enable the Cloud Tasks API.](https://console.cloud.google.com/apis/library/tasks.googleapis.com)
15
15
  4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
16
16
 
17
17
  ### Installation
data/lib/google/cloud/tasks.rb CHANGED
@@ -23,8 +23,7 @@ module Google
23
23
  # # Ruby Client for Cloud Tasks API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
24
24
  #
25
25
  # [Cloud Tasks API][Product Documentation]:
26
- # Manages the execution of large numbers of distributed requests. Cloud Tasks
27
- # is in Alpha.
26
+ # Manages the execution of large numbers of distributed requests.
28
27
  # - [Product Documentation][]
29
28
  #
30
29
  # ## Quick Start
@@ -33,7 +32,7 @@ module Google
33
32
  #
34
33
  # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
35
34
  # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
36
- # 3. [Enable the Cloud Tasks API.](https://console.cloud.google.com/apis/api/cloudtasks)
35
+ # 3. [Enable the Cloud Tasks API.](https://console.cloud.google.com/apis/library/tasks.googleapis.com)
37
36
  # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
38
37
  #
39
38
  # ### Next Steps
@@ -42,8 +41,33 @@ module Google
42
41
  # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
43
42
  # to see the full list of Cloud APIs that we cover.
44
43
  #
45
- # [Product Documentation]: https://cloud.google.com/cloudtasks
44
+ # [Product Documentation]: https://cloud.google.com/tasks
46
45
  #
46
+ # ## Enabling Logging
47
+ #
48
+ # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
49
+ # 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,
50
+ # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
51
+ # 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)
52
+ # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
53
+ #
54
+ # Configuring a Ruby stdlib logger:
55
+ #
56
+ # ```ruby
57
+ # require "logger"
58
+ #
59
+ # module MyLogger
60
+ # LOGGER = Logger.new $stderr, level: Logger::WARN
61
+ # def logger
62
+ # LOGGER
63
+ # end
64
+ # end
65
+ #
66
+ # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
67
+ # module GRPC
68
+ # extend MyLogger
69
+ # end
70
+ # ```
47
71
  #
48
72
  module Tasks
49
73
  # rubocop:enable LineLength
@@ -88,6 +112,11 @@ module Google
88
112
  # or the specified config is missing data points.
89
113
  # @param timeout [Numeric]
90
114
  # The default timeout, in seconds, for calls made through this client.
115
+ # @param metadata [Hash]
116
+ # Default metadata to be sent with each request. This can be overridden on a per call basis.
117
+ # @param exception_transformer [Proc]
118
+ # An optional proc that intercepts any exceptions raised during an API call to inject
119
+ # custom error handling.
91
120
  def self.new(*args, version: :v2beta2, **kwargs)
92
121
  unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
93
122
  raise "The version: #{version} is not available. The available versions " \
data/lib/google/cloud/tasks/v2beta2.rb CHANGED
@@ -16,59 +16,59 @@ require "google/cloud/tasks/v2beta2/cloud_tasks_client"
16
16
 
17
17
  module Google
18
18
  module Cloud
19
- # rubocop:disable LineLength
20
-
21
- ##
22
- # # Ruby Client for Cloud Tasks API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
23
- #
24
- # [Cloud Tasks API][Product Documentation]:
25
- # Manages the execution of large numbers of distributed requests.
26
- # - [Product Documentation][]
27
- #
28
- # ## Quick Start
29
- # In order to use this library, you first need to go through the following
30
- # steps:
31
- #
32
- # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
33
- # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
34
- # 3. [Enable the Cloud Tasks API.](https://console.cloud.google.com/apis/api/tasks)
35
- # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
36
- #
37
- # ### Next Steps
38
- # - Read the [Cloud Tasks API Product documentation][Product Documentation]
39
- # to learn more about the product and see How-to Guides.
40
- # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
41
- # to see the full list of Cloud APIs that we cover.
42
- #
43
- # [Product Documentation]: https://cloud.google.com/tasks
44
- #
45
- # ## Enabling Logging
46
- #
47
- # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
48
- # 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,
49
- # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
50
- # 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)
51
- # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
52
- #
53
- # Configuring a Ruby stdlib logger:
54
- #
55
- # ```ruby
56
- # require "logger"
57
- #
58
- # module MyLogger
59
- # LOGGER = Logger.new $stderr, level: Logger::WARN
60
- # def logger
61
- # LOGGER
62
- # end
63
- # end
64
- #
65
- # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
66
- # module GRPC
67
- # extend MyLogger
68
- # end
69
- # ```
70
- #
71
19
  module Tasks
20
+ # rubocop:disable LineLength
21
+
22
+ ##
23
+ # # Ruby Client for Cloud Tasks API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
24
+ #
25
+ # [Cloud Tasks API][Product Documentation]:
26
+ # Manages the execution of large numbers of distributed requests.
27
+ # - [Product Documentation][]
28
+ #
29
+ # ## Quick Start
30
+ # In order to use this library, you first need to go through the following
31
+ # steps:
32
+ #
33
+ # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
34
+ # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
35
+ # 3. [Enable the Cloud Tasks API.](https://console.cloud.google.com/apis/library/tasks.googleapis.com)
36
+ # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
37
+ #
38
+ # ### Next Steps
39
+ # - Read the [Cloud Tasks API Product documentation][Product Documentation]
40
+ # to learn more about the product and see How-to Guides.
41
+ # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
42
+ # to see the full list of Cloud APIs that we cover.
43
+ #
44
+ # [Product Documentation]: https://cloud.google.com/tasks
45
+ #
46
+ # ## Enabling Logging
47
+ #
48
+ # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
49
+ # 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,
50
+ # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
51
+ # 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)
52
+ # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
53
+ #
54
+ # Configuring a Ruby stdlib logger:
55
+ #
56
+ # ```ruby
57
+ # require "logger"
58
+ #
59
+ # module MyLogger
60
+ # LOGGER = Logger.new $stderr, level: Logger::WARN
61
+ # def logger
62
+ # LOGGER
63
+ # end
64
+ # end
65
+ #
66
+ # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
67
+ # module GRPC
68
+ # extend MyLogger
69
+ # end
70
+ # ```
71
+ #
72
72
  module V2beta2
73
73
  # rubocop:enable LineLength
74
74
 
data/lib/google/cloud/tasks/v2beta2/cloud_tasks_client.rb CHANGED
@@ -448,9 +448,9 @@ module Google
448
448
  # object.
449
449
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
450
450
  # @example
451
- # require "google/cloud/tasks/v2beta2"
451
+ # require "google/cloud/tasks"
452
452
  #
453
- # cloud_tasks_client = Google::Cloud::Tasks::V2beta2.new
453
+ # cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
454
454
  # formatted_parent = Google::Cloud::Tasks::V2beta2::CloudTasksClient.location_path("[PROJECT]", "[LOCATION]")
455
455
  #
456
456
  # # Iterate over all results.
@@ -497,9 +497,9 @@ module Google
497
497
  # @return [Google::Cloud::Tasks::V2beta2::Queue]
498
498
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
499
499
  # @example
500
- # require "google/cloud/tasks/v2beta2"
500
+ # require "google/cloud/tasks"
501
501
  #
502
- # cloud_tasks_client = Google::Cloud::Tasks::V2beta2.new
502
+ # cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
503
503
  # formatted_name = Google::Cloud::Tasks::V2beta2::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
504
504
  # response = cloud_tasks_client.get_queue(formatted_name)
505
505
 
@@ -523,7 +523,7 @@ module Google
523
523
  # WARNING: Using this method may have unintended side effects if you are
524
524
  # using an App Engine +queue.yaml+ or +queue.xml+ file to manage your queues.
525
525
  # Read
526
- # [Overview of Queue Management and queue.yaml](https://cloud.google.com/cloud-tasks/docs/queue-yaml)
526
+ # [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
527
527
  # before using this method.
528
528
  #
529
529
  # @param parent [String]
@@ -552,9 +552,9 @@ module Google
552
552
  # @return [Google::Cloud::Tasks::V2beta2::Queue]
553
553
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
554
554
  # @example
555
- # require "google/cloud/tasks/v2beta2"
555
+ # require "google/cloud/tasks"
556
556
  #
557
- # cloud_tasks_client = Google::Cloud::Tasks::V2beta2.new
557
+ # cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
558
558
  # formatted_parent = Google::Cloud::Tasks::V2beta2::CloudTasksClient.location_path("[PROJECT]", "[LOCATION]")
559
559
  #
560
560
  # # TODO: Initialize +queue+:
@@ -586,7 +586,7 @@ module Google
586
586
  # WARNING: Using this method may have unintended side effects if you are
587
587
  # using an App Engine +queue.yaml+ or +queue.xml+ file to manage your queues.
588
588
  # Read
589
- # [Overview of Queue Management and queue.yaml](https://cloud.google.com/cloud-tasks/docs/queue-yaml)
589
+ # [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
590
590
  # before using this method.
591
591
  #
592
592
  # @param queue [Google::Cloud::Tasks::V2beta2::Queue | Hash]
@@ -616,9 +616,9 @@ module Google
616
616
  # @return [Google::Cloud::Tasks::V2beta2::Queue]
617
617
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
618
618
  # @example
619
- # require "google/cloud/tasks/v2beta2"
619
+ # require "google/cloud/tasks"
620
620
  #
621
- # cloud_tasks_client = Google::Cloud::Tasks::V2beta2.new
621
+ # cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
622
622
  #
623
623
  # # TODO: Initialize +queue+:
624
624
  # queue = {}
@@ -647,7 +647,7 @@ module Google
647
647
  # WARNING: Using this method may have unintended side effects if you are
648
648
  # using an App Engine +queue.yaml+ or +queue.xml+ file to manage your queues.
649
649
  # Read
650
- # [Overview of Queue Management and queue.yaml](https://cloud.google.com/cloud-tasks/docs/queue-yaml)
650
+ # [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
651
651
  # before using this method.
652
652
  #
653
653
  # @param name [String]
@@ -663,9 +663,9 @@ module Google
663
663
  # @yieldparam operation [GRPC::ActiveCall::Operation]
664
664
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
665
665
  # @example
666
- # require "google/cloud/tasks/v2beta2"
666
+ # require "google/cloud/tasks"
667
667
  #
668
- # cloud_tasks_client = Google::Cloud::Tasks::V2beta2.new
668
+ # cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
669
669
  # formatted_name = Google::Cloud::Tasks::V2beta2::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
670
670
  # cloud_tasks_client.delete_queue(formatted_name)
671
671
 
@@ -702,9 +702,9 @@ module Google
702
702
  # @return [Google::Cloud::Tasks::V2beta2::Queue]
703
703
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
704
704
  # @example
705
- # require "google/cloud/tasks/v2beta2"
705
+ # require "google/cloud/tasks"
706
706
  #
707
- # cloud_tasks_client = Google::Cloud::Tasks::V2beta2.new
707
+ # cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
708
708
  # formatted_name = Google::Cloud::Tasks::V2beta2::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
709
709
  # response = cloud_tasks_client.purge_queue(formatted_name)
710
710
 
@@ -741,9 +741,9 @@ module Google
741
741
  # @return [Google::Cloud::Tasks::V2beta2::Queue]
742
742
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
743
743
  # @example
744
- # require "google/cloud/tasks/v2beta2"
744
+ # require "google/cloud/tasks"
745
745
  #
746
- # cloud_tasks_client = Google::Cloud::Tasks::V2beta2.new
746
+ # cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
747
747
  # formatted_name = Google::Cloud::Tasks::V2beta2::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
748
748
  # response = cloud_tasks_client.pause_queue(formatted_name)
749
749
 
@@ -769,7 +769,7 @@ module Google
769
769
  # WARNING: Resuming many high-QPS queues at the same time can
770
770
  # lead to target overloading. If you are resuming high-QPS
771
771
  # queues, follow the 500/50/5 pattern described in
772
- # [Managing Cloud Tasks Scaling Risks](https://cloud.google.com/cloud-tasks/pdfs/managing-cloud-tasks-scaling-risks-2017-06-05.pdf).
772
+ # [Managing Cloud Tasks Scaling Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
773
773
  #
774
774
  # @param name [String]
775
775
  # Required.
@@ -785,9 +785,9 @@ module Google
785
785
  # @return [Google::Cloud::Tasks::V2beta2::Queue]
786
786
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
787
787
  # @example
788
- # require "google/cloud/tasks/v2beta2"
788
+ # require "google/cloud/tasks"
789
789
  #
790
- # cloud_tasks_client = Google::Cloud::Tasks::V2beta2.new
790
+ # cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
791
791
  # formatted_name = Google::Cloud::Tasks::V2beta2::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
792
792
  # response = cloud_tasks_client.resume_queue(formatted_name)
793
793
 
@@ -806,8 +806,9 @@ module Google
806
806
  # Returns an empty policy if the resource exists and does not have a policy
807
807
  # set.
808
808
  #
809
- # Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission on the
810
- # specified resource parent:
809
+ # Authorization requires the following
810
+ # [Google IAM](https://cloud.google.com/iam) permission on the specified
811
+ # resource parent:
811
812
  #
812
813
  # * +cloudtasks.queues.getIamPolicy+
813
814
  #
@@ -824,9 +825,9 @@ module Google
824
825
  # @return [Google::Iam::V1::Policy]
825
826
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
826
827
  # @example
827
- # require "google/cloud/tasks/v2beta2"
828
+ # require "google/cloud/tasks"
828
829
  #
829
- # cloud_tasks_client = Google::Cloud::Tasks::V2beta2.new
830
+ # cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
830
831
  # formatted_resource = Google::Cloud::Tasks::V2beta2::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
831
832
  # response = cloud_tasks_client.get_iam_policy(formatted_resource)
832
833
 
@@ -847,8 +848,9 @@ module Google
847
848
  # Note: The Cloud Console does not check queue-level IAM permissions yet.
848
849
  # Project-level permissions are required to use the Cloud Console.
849
850
  #
850
- # Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission on the
851
- # specified resource parent:
851
+ # Authorization requires the following
852
+ # [Google IAM](https://cloud.google.com/iam) permission on the specified
853
+ # resource parent:
852
854
  #
853
855
  # * +cloudtasks.queues.setIamPolicy+
854
856
  #
@@ -872,9 +874,9 @@ module Google
872
874
  # @return [Google::Iam::V1::Policy]
873
875
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
874
876
  # @example
875
- # require "google/cloud/tasks/v2beta2"
877
+ # require "google/cloud/tasks"
876
878
  #
877
- # cloud_tasks_client = Google::Cloud::Tasks::V2beta2.new
879
+ # cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
878
880
  # formatted_resource = Google::Cloud::Tasks::V2beta2::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
879
881
  #
880
882
  # # TODO: Initialize +policy+:
@@ -920,9 +922,9 @@ module Google
920
922
  # @return [Google::Iam::V1::TestIamPermissionsResponse]
921
923
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
922
924
  # @example
923
- # require "google/cloud/tasks/v2beta2"
925
+ # require "google/cloud/tasks"
924
926
  #
925
- # cloud_tasks_client = Google::Cloud::Tasks::V2beta2.new
927
+ # cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
926
928
  # formatted_resource = Google::Cloud::Tasks::V2beta2::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
927
929
  #
928
930
  # # TODO: Initialize +permissions+:
@@ -949,6 +951,9 @@ module Google
949
951
  # {Google::Cloud::Tasks::V2beta2::ListTasksRequest#response_view response_view} controls the
950
952
  # subset of information which is returned.
951
953
  #
954
+ # The tasks may be returned in any order. The ordering may change at any
955
+ # time.
956
+ #
952
957
  # @param parent [String]
953
958
  # Required.
954
959
  #
@@ -965,13 +970,8 @@ module Google
965
970
  # contains.
966
971
  #
967
972
  # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
968
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/) permission on the
969
- # {Google::Cloud::Tasks::V2beta2::Task Task} resource.
970
- # @param order_by [String]
971
- # Sort order used for the query. The only fields supported for sorting
972
- # are +schedule_time+ and +pull_message.tag+. All results will be
973
- # returned in approximately ascending order. The default ordering is by
974
- # +schedule_time+.
973
+ # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
974
+ # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
975
975
  # @param page_size [Integer]
976
976
  # The maximum number of resources contained in the underlying API
977
977
  # response. If page streaming is performed per-resource, this
@@ -991,9 +991,9 @@ module Google
991
991
  # object.
992
992
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
993
993
  # @example
994
- # require "google/cloud/tasks/v2beta2"
994
+ # require "google/cloud/tasks"
995
995
  #
996
- # cloud_tasks_client = Google::Cloud::Tasks::V2beta2.new
996
+ # cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
997
997
  # formatted_parent = Google::Cloud::Tasks::V2beta2::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
998
998
  #
999
999
  # # Iterate over all results.
@@ -1012,14 +1012,12 @@ module Google
1012
1012
  def list_tasks \
1013
1013
  parent,
1014
1014
  response_view: nil,
1015
- order_by: nil,
1016
1015
  page_size: nil,
1017
1016
  options: nil,
1018
1017
  &block
1019
1018
  req = {
1020
1019
  parent: parent,
1021
1020
  response_view: response_view,
1022
- order_by: order_by,
1023
1021
  page_size: page_size
1024
1022
  }.delete_if { |_, v| v.nil? }
1025
1023
  req = Google::Gax::to_proto(req, Google::Cloud::Tasks::V2beta2::ListTasksRequest)
@@ -1044,8 +1042,8 @@ module Google
1044
1042
  # contains.
1045
1043
  #
1046
1044
  # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1047
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/) permission on the
1048
- # {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1045
+ # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
1046
+ # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1049
1047
  # @param options [Google::Gax::CallOptions]
1050
1048
  # Overrides the default settings for this call, e.g, timeout,
1051
1049
  # retries, etc.
@@ -1055,9 +1053,9 @@ module Google
1055
1053
  # @return [Google::Cloud::Tasks::V2beta2::Task]
1056
1054
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
1057
1055
  # @example
1058
- # require "google/cloud/tasks/v2beta2"
1056
+ # require "google/cloud/tasks"
1059
1057
  #
1060
- # cloud_tasks_client = Google::Cloud::Tasks::V2beta2.new
1058
+ # cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
1061
1059
  # formatted_name = Google::Cloud::Tasks::V2beta2::CloudTasksClient.task_path("[PROJECT]", "[LOCATION]", "[QUEUE]", "[TASK]")
1062
1060
  # response = cloud_tasks_client.get_task(formatted_name)
1063
1061
 
@@ -1078,10 +1076,9 @@ module Google
1078
1076
  #
1079
1077
  # Tasks cannot be updated after creation; there is no UpdateTask command.
1080
1078
  #
1081
- # * For [App Engine queues](https://cloud.google.comgoogle.cloud.tasks.v2beta2.AppEngineHttpTarget),
1082
- # the maximum task size is 100KB.
1083
- # * For [pull queues](https://cloud.google.comgoogle.cloud.tasks.v2beta2.PullTarget), this
1084
- # the maximum task size is 1MB.
1079
+ # * For {Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget App Engine queues}, the maximum task size is
1080
+ # 100KB.
1081
+ # * For {Google::Cloud::Tasks::V2beta2::PullTarget pull queues}, the maximum task size is 1MB.
1085
1082
  #
1086
1083
  # @param parent [String]
1087
1084
  # Required.
@@ -1139,8 +1136,8 @@ module Google
1139
1136
  # contains.
1140
1137
  #
1141
1138
  # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1142
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/) permission on the
1143
- # {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1139
+ # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
1140
+ # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1144
1141
  # @param options [Google::Gax::CallOptions]
1145
1142
  # Overrides the default settings for this call, e.g, timeout,
1146
1143
  # retries, etc.
@@ -1150,9 +1147,9 @@ module Google
1150
1147
  # @return [Google::Cloud::Tasks::V2beta2::Task]
1151
1148
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
1152
1149
  # @example
1153
- # require "google/cloud/tasks/v2beta2"
1150
+ # require "google/cloud/tasks"
1154
1151
  #
1155
- # cloud_tasks_client = Google::Cloud::Tasks::V2beta2.new
1152
+ # cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
1156
1153
  # formatted_parent = Google::Cloud::Tasks::V2beta2::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
1157
1154
  #
1158
1155
  # # TODO: Initialize +task+:
@@ -1193,9 +1190,9 @@ module Google
1193
1190
  # @yieldparam operation [GRPC::ActiveCall::Operation]
1194
1191
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
1195
1192
  # @example
1196
- # require "google/cloud/tasks/v2beta2"
1193
+ # require "google/cloud/tasks"
1197
1194
  #
1198
- # cloud_tasks_client = Google::Cloud::Tasks::V2beta2.new
1195
+ # cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
1199
1196
  # formatted_name = Google::Cloud::Tasks::V2beta2::CloudTasksClient.task_path("[PROJECT]", "[LOCATION]", "[QUEUE]", "[TASK]")
1200
1197
  # cloud_tasks_client.delete_task(formatted_name)
1201
1198
 
@@ -1269,8 +1266,8 @@ module Google
1269
1266
  # contains.
1270
1267
  #
1271
1268
  # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1272
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/) permission on the
1273
- # {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1269
+ # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
1270
+ # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1274
1271
  # @param filter [String]
1275
1272
  # +filter+ can be used to specify a subset of tasks to lease.
1276
1273
  #
@@ -1310,9 +1307,9 @@ module Google
1310
1307
  # @return [Google::Cloud::Tasks::V2beta2::LeaseTasksResponse]
1311
1308
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
1312
1309
  # @example
1313
- # require "google/cloud/tasks/v2beta2"
1310
+ # require "google/cloud/tasks"
1314
1311
  #
1315
- # cloud_tasks_client = Google::Cloud::Tasks::V2beta2.new
1312
+ # cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
1316
1313
  # formatted_parent = Google::Cloud::Tasks::V2beta2::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
1317
1314
  #
1318
1315
  # # TODO: Initialize +lease_duration+:
@@ -1375,9 +1372,9 @@ module Google
1375
1372
  # @yieldparam operation [GRPC::ActiveCall::Operation]
1376
1373
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
1377
1374
  # @example
1378
- # require "google/cloud/tasks/v2beta2"
1375
+ # require "google/cloud/tasks"
1379
1376
  #
1380
- # cloud_tasks_client = Google::Cloud::Tasks::V2beta2.new
1377
+ # cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
1381
1378
  # formatted_name = Google::Cloud::Tasks::V2beta2::CloudTasksClient.task_path("[PROJECT]", "[LOCATION]", "[QUEUE]", "[TASK]")
1382
1379
  #
1383
1380
  # # TODO: Initialize +schedule_time+:
@@ -1440,8 +1437,8 @@ module Google
1440
1437
  # contains.
1441
1438
  #
1442
1439
  # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1443
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/) permission on the
1444
- # {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1440
+ # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
1441
+ # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1445
1442
  # @param options [Google::Gax::CallOptions]
1446
1443
  # Overrides the default settings for this call, e.g, timeout,
1447
1444
  # retries, etc.
@@ -1451,9 +1448,9 @@ module Google
1451
1448
  # @return [Google::Cloud::Tasks::V2beta2::Task]
1452
1449
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
1453
1450
  # @example
1454
- # require "google/cloud/tasks/v2beta2"
1451
+ # require "google/cloud/tasks"
1455
1452
  #
1456
- # cloud_tasks_client = Google::Cloud::Tasks::V2beta2.new
1453
+ # cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
1457
1454
  # formatted_name = Google::Cloud::Tasks::V2beta2::CloudTasksClient.task_path("[PROJECT]", "[LOCATION]", "[QUEUE]", "[TASK]")
1458
1455
  #
1459
1456
  # # TODO: Initialize +schedule_time+:
@@ -1513,8 +1510,8 @@ module Google
1513
1510
  # contains.
1514
1511
  #
1515
1512
  # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1516
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/) permission on the
1517
- # {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1513
+ # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
1514
+ # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1518
1515
  # @param options [Google::Gax::CallOptions]
1519
1516
  # Overrides the default settings for this call, e.g, timeout,
1520
1517
  # retries, etc.
@@ -1524,9 +1521,9 @@ module Google
1524
1521
  # @return [Google::Cloud::Tasks::V2beta2::Task]
1525
1522
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
1526
1523
  # @example
1527
- # require "google/cloud/tasks/v2beta2"
1524
+ # require "google/cloud/tasks"
1528
1525
  #
1529
- # cloud_tasks_client = Google::Cloud::Tasks::V2beta2.new
1526
+ # cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
1530
1527
  # formatted_name = Google::Cloud::Tasks::V2beta2::CloudTasksClient.task_path("[PROJECT]", "[LOCATION]", "[QUEUE]", "[TASK]")
1531
1528
  #
1532
1529
  # # TODO: Initialize +schedule_time+:
@@ -1592,8 +1589,8 @@ module Google
1592
1589
  # contains.
1593
1590
  #
1594
1591
  # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1595
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/) permission on the
1596
- # {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1592
+ # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
1593
+ # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
1597
1594
  # @param options [Google::Gax::CallOptions]
1598
1595
  # Overrides the default settings for this call, e.g, timeout,
1599
1596
  # retries, etc.
@@ -1603,9 +1600,9 @@ module Google
1603
1600
  # @return [Google::Cloud::Tasks::V2beta2::Task]
1604
1601
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
1605
1602
  # @example
1606
- # require "google/cloud/tasks/v2beta2"
1603
+ # require "google/cloud/tasks"
1607
1604
  #
1608
- # cloud_tasks_client = Google::Cloud::Tasks::V2beta2.new
1605
+ # cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
1609
1606
  # formatted_name = Google::Cloud::Tasks::V2beta2::CloudTasksClient.task_path("[PROJECT]", "[LOCATION]", "[QUEUE]", "[TASK]")
1610
1607
  # response = cloud_tasks_client.run_task(formatted_name)
1611
1608
 
data/lib/google/cloud/tasks/v2beta2/cloudtasks_pb.rb CHANGED
@@ -50,7 +50,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
50
50
  add_message "google.cloud.tasks.v2beta2.ListTasksRequest" do
51
51
  optional :parent, :string, 1
52
52
  optional :response_view, :enum, 2, "google.cloud.tasks.v2beta2.Task.View"
53
- optional :order_by, :string, 3
54
53
  optional :page_size, :int32, 4
55
54
  optional :page_token, :string, 5
56
55
  end
data/lib/google/cloud/tasks/v2beta2/cloudtasks_services_pb.rb CHANGED
@@ -1,7 +1,7 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # Source: google/cloud/tasks/v2beta2/cloudtasks.proto for package 'google.cloud.tasks.v2beta2'
3
3
  # Original file comments:
4
- # Copyright 2018 Google Inc.
4
+ # Copyright 2018 Google LLC
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -49,7 +49,7 @@ module Google
49
49
  # WARNING: Using this method may have unintended side effects if you are
50
50
  # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
51
51
  # Read
52
- # [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)
52
+ # [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
53
53
  # before using this method.
54
54
  rpc :CreateQueue, CreateQueueRequest, Queue
55
55
  # Updates a queue.
@@ -64,7 +64,7 @@ module Google
64
64
  # WARNING: Using this method may have unintended side effects if you are
65
65
  # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
66
66
  # Read
67
- # [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)
67
+ # [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
68
68
  # before using this method.
69
69
  rpc :UpdateQueue, UpdateQueueRequest, Queue
70
70
  # Deletes a queue.
@@ -77,7 +77,7 @@ module Google
77
77
  # WARNING: Using this method may have unintended side effects if you are
78
78
  # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
79
79
  # Read
80
- # [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)
80
+ # [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
81
81
  # before using this method.
82
82
  rpc :DeleteQueue, DeleteQueueRequest, Google::Protobuf::Empty
83
83
  # Purges a queue by deleting all of its tasks.
@@ -106,14 +106,15 @@ module Google
106
106
  # WARNING: Resuming many high-QPS queues at the same time can
107
107
  # lead to target overloading. If you are resuming high-QPS
108
108
  # queues, follow the 500/50/5 pattern described in
109
- # [Managing Cloud Tasks Scaling Risks](/cloud-tasks/pdfs/managing-cloud-tasks-scaling-risks-2017-06-05.pdf).
109
+ # [Managing Cloud Tasks Scaling Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
110
110
  rpc :ResumeQueue, ResumeQueueRequest, Queue
111
111
  # Gets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue].
112
112
  # Returns an empty policy if the resource exists and does not have a policy
113
113
  # set.
114
114
  #
115
- # Authorization requires the following [Google IAM](/iam) permission on the
116
- # specified resource parent:
115
+ # Authorization requires the following
116
+ # [Google IAM](https://cloud.google.com/iam) permission on the specified
117
+ # resource parent:
117
118
  #
118
119
  # * `cloudtasks.queues.getIamPolicy`
119
120
  rpc :GetIamPolicy, Google::Iam::V1::GetIamPolicyRequest, Google::Iam::V1::Policy
@@ -123,8 +124,9 @@ module Google
123
124
  # Note: The Cloud Console does not check queue-level IAM permissions yet.
124
125
  # Project-level permissions are required to use the Cloud Console.
125
126
  #
126
- # Authorization requires the following [Google IAM](/iam) permission on the
127
- # specified resource parent:
127
+ # Authorization requires the following
128
+ # [Google IAM](https://cloud.google.com/iam) permission on the specified
129
+ # resource parent:
128
130
  #
129
131
  # * `cloudtasks.queues.setIamPolicy`
130
132
  rpc :SetIamPolicy, Google::Iam::V1::SetIamPolicyRequest, Google::Iam::V1::Policy
@@ -142,6 +144,9 @@ module Google
142
144
  # due to performance considerations;
143
145
  # [response_view][google.cloud.tasks.v2beta2.ListTasksRequest.response_view] controls the
144
146
  # subset of information which is returned.
147
+ #
148
+ # The tasks may be returned in any order. The ordering may change at any
149
+ # time.
145
150
  rpc :ListTasks, ListTasksRequest, ListTasksResponse
146
151
  # Gets a task.
147
152
  rpc :GetTask, GetTaskRequest, Task
@@ -149,10 +154,9 @@ module Google
149
154
  #
150
155
  # Tasks cannot be updated after creation; there is no UpdateTask command.
151
156
  #
152
- # * For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),
153
- # the maximum task size is 100KB.
154
- # * For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this
155
- # the maximum task size is 1MB.
157
+ # * For [App Engine queues][google.cloud.tasks.v2beta2.AppEngineHttpTarget], the maximum task size is
158
+ # 100KB.
159
+ # * For [pull queues][google.cloud.tasks.v2beta2.PullTarget], the maximum task size is 1MB.
156
160
  rpc :CreateTask, CreateTaskRequest, Task
157
161
  # Deletes a task.
158
162
  #
data/lib/google/cloud/tasks/v2beta2/credentials.rb CHANGED
@@ -22,8 +22,16 @@ module Google
22
22
  SCOPE = [
23
23
  "https://www.googleapis.com/auth/cloud-platform"
24
24
  ].freeze
25
- PATH_ENV_VARS = %w(TASKS_KEYFILE GOOGLE_CLOUD_KEYFILE GCLOUD_KEYFILE)
26
- JSON_ENV_VARS = %w(TASKS_KEYFILE_JSON GOOGLE_CLOUD_KEYFILE_JSON GCLOUD_KEYFILE_JSON)
25
+ PATH_ENV_VARS = %w(TASKS_CREDENTIALS
26
+ TASKS_KEYFILE
27
+ GOOGLE_CLOUD_CREDENTIALS
28
+ GOOGLE_CLOUD_KEYFILE
29
+ GCLOUD_KEYFILE)
30
+ JSON_ENV_VARS = %w(TASKS_CREDENTIALS_JSON
31
+ TASKS_KEYFILE_JSON
32
+ GOOGLE_CLOUD_CREDENTIALS_JSON
33
+ GOOGLE_CLOUD_KEYFILE_JSON
34
+ GCLOUD_KEYFILE_JSON)
27
35
  DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"]
28
36
  end
29
37
  end
data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/cloudtasks.rb CHANGED
@@ -15,17 +15,6 @@
15
15
  module Google
16
16
  module Cloud
17
17
  module Tasks
18
- ##
19
- # # Cloud Tasks API Contents
20
- #
21
- # | Class | Description |
22
- # | ----- | ----------- |
23
- # | [CloudTasksClient][] | Cloud Tasks allows developers to manage the execution of background work in their applications. |
24
- # | [Data Types][] | Data types for Google::Cloud::Tasks::V2beta2 |
25
- #
26
- # [CloudTasksClient]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-tasks/latest/google/cloud/tasks/v2beta2/cloudtasksclient
27
- # [Data Types]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-tasks/latest/google/cloud/tasks/v2beta2/datatypes
28
- #
29
18
  module V2beta2
30
19
  # Request message for {Google::Cloud::Tasks::V2beta2::CloudTasks::ListQueues ListQueues}.
31
20
  # @!attribute [rw] parent
@@ -187,14 +176,8 @@ module Google
187
176
  # contains.
188
177
  #
189
178
  # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
190
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/) permission on the
191
- # {Google::Cloud::Tasks::V2beta2::Task Task} resource.
192
- # @!attribute [rw] order_by
193
- # @return [String]
194
- # Sort order used for the query. The only fields supported for sorting
195
- # are +schedule_time+ and +pull_message.tag+. All results will be
196
- # returned in approximately ascending order. The default ordering is by
197
- # +schedule_time+.
179
+ # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
180
+ # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
198
181
  # @!attribute [rw] page_size
199
182
  # @return [Integer]
200
183
  # Requested page size. Fewer tasks than requested might be returned.
@@ -251,8 +234,8 @@ module Google
251
234
  # contains.
252
235
  #
253
236
  # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
254
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/) permission on the
255
- # {Google::Cloud::Tasks::V2beta2::Task Task} resource.
237
+ # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
238
+ # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
256
239
  class GetTaskRequest; end
257
240
 
258
241
  # Request message for {Google::Cloud::Tasks::V2beta2::CloudTasks::CreateTask CreateTask}.
@@ -313,8 +296,8 @@ module Google
313
296
  # contains.
314
297
  #
315
298
  # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
316
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/) permission on the
317
- # {Google::Cloud::Tasks::V2beta2::Task Task} resource.
299
+ # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
300
+ # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
318
301
  class CreateTaskRequest; end
319
302
 
320
303
  # Request message for deleting a task using
@@ -365,8 +348,8 @@ module Google
365
348
  # contains.
366
349
  #
367
350
  # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
368
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/) permission on the
369
- # {Google::Cloud::Tasks::V2beta2::Task Task} resource.
351
+ # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
352
+ # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
370
353
  # @!attribute [rw] filter
371
354
  # @return [String]
372
355
  # +filter+ can be used to specify a subset of tasks to lease.
@@ -463,8 +446,8 @@ module Google
463
446
  # contains.
464
447
  #
465
448
  # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
466
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/) permission on the
467
- # {Google::Cloud::Tasks::V2beta2::Task Task} resource.
449
+ # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
450
+ # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
468
451
  class RenewLeaseRequest; end
469
452
 
470
453
  # Request message for canceling a lease using
@@ -496,8 +479,8 @@ module Google
496
479
  # contains.
497
480
  #
498
481
  # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
499
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/) permission on the
500
- # {Google::Cloud::Tasks::V2beta2::Task Task} resource.
482
+ # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
483
+ # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
501
484
  class CancelLeaseRequest; end
502
485
 
503
486
  # Request message for forcing a task to run now using
@@ -520,8 +503,8 @@ module Google
520
503
  # contains.
521
504
  #
522
505
  # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
523
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/) permission on the
524
- # {Google::Cloud::Tasks::V2beta2::Task Task} resource.
506
+ # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
507
+ # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
525
508
  class RunTaskRequest; end
526
509
  end
527
510
  end
data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/queue.rb CHANGED
@@ -125,7 +125,7 @@ module Google
125
125
  #
126
126
  # A queue becomes +DISABLED+ when
127
127
  # [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref) or
128
- # [queue.xml](https://cloud.google.comappengine/docs/standard/java/config/queueref) is uploaded
128
+ # [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref) is uploaded
129
129
  # which does not contain the queue. You cannot directly disable a queue.
130
130
  #
131
131
  # When a queue is disabled, tasks can still be added to a queue
@@ -153,11 +153,11 @@ module Google
153
153
  # If unspecified when the queue is created, Cloud Tasks will pick the
154
154
  # default.
155
155
  #
156
- # * For App Engine queues, the maximum allowed value is 500.
157
- # * This field is output only for [pull queues](https://cloud.google.comgoogle.cloud.tasks.v2beta2.PullTarget). In
158
- # addition to the +max_tasks_dispatched_per_second+ limit, a
159
- # maximum of 10 QPS of {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks}
160
- # requests are allowed per pull queue.
156
+ # * For {Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget App Engine queues}, the maximum allowed value
157
+ # is 500.
158
+ # * This field is output only for {Google::Cloud::Tasks::V2beta2::PullTarget pull queues}. In addition to the
159
+ # +max_tasks_dispatched_per_second+ limit, a maximum of 10 QPS of
160
+ # {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} requests are allowed per pull queue.
161
161
  #
162
162
  #
163
163
  # This field has the same meaning as
@@ -210,9 +210,8 @@ module Google
210
210
  # The maximum allowed value is 5,000.
211
211
  #
212
212
  # This field is output only for
213
- # [pull queues](https://cloud.google.comgoogle.cloud.tasks.v2beta2.PullTarget) and always -1, which
214
- # indicates no limit. No other queue types can have +max_concurrent_tasks+
215
- # set to -1.
213
+ # {Google::Cloud::Tasks::V2beta2::PullTarget pull queues} and always -1, which indicates no limit. No other
214
+ # queue types can have +max_concurrent_tasks+ set to -1.
216
215
  #
217
216
  #
218
217
  # This field has the same meaning as
@@ -246,8 +245,7 @@ module Google
246
245
  # If unspecified when the queue is created, Cloud Tasks will pick the
247
246
  # default.
248
247
  #
249
- # This field is output only for
250
- # [pull queues](https://cloud.google.comgoogle.cloud.tasks.v2beta2.PullTarget).
248
+ # This field is output only for {Google::Cloud::Tasks::V2beta2::PullTarget pull queues}.
251
249
  #
252
250
  #
253
251
  # +max_retry_duration+ will be truncated to the nearest second.
@@ -256,7 +254,7 @@ module Google
256
254
  # [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
257
255
  # @!attribute [rw] min_backoff
258
256
  # @return [Google::Protobuf::Duration]
259
- # A task will be [scheduled](https://cloud.google.comTask.schedule_time) for retry between
257
+ # A task will be {Google::Cloud::Tasks::V2beta2::Task#schedule_time scheduled} for retry between
260
258
  # {Google::Cloud::Tasks::V2beta2::RetryConfig#min_backoff min_backoff} and
261
259
  # {Google::Cloud::Tasks::V2beta2::RetryConfig#max_backoff max_backoff} duration after it fails,
262
260
  # if the queue's {Google::Cloud::Tasks::V2beta2::RetryConfig RetryConfig} specifies that the task should be
@@ -265,8 +263,7 @@ module Google
265
263
  # If unspecified when the queue is created, Cloud Tasks will pick the
266
264
  # default.
267
265
  #
268
- # This field is output only for
269
- # [pull queues](https://cloud.google.comgoogle.cloud.tasks.v2beta2.PullTarget).
266
+ # This field is output only for {Google::Cloud::Tasks::V2beta2::PullTarget pull queues}.
270
267
  #
271
268
  #
272
269
  # +min_backoff+ will be truncated to the nearest second.
@@ -275,7 +272,7 @@ module Google
275
272
  # [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
276
273
  # @!attribute [rw] max_backoff
277
274
  # @return [Google::Protobuf::Duration]
278
- # A task will be [scheduled](https://cloud.google.comTask.schedule_time) for retry between
275
+ # A task will be {Google::Cloud::Tasks::V2beta2::Task#schedule_time scheduled} for retry between
279
276
  # {Google::Cloud::Tasks::V2beta2::RetryConfig#min_backoff min_backoff} and
280
277
  # {Google::Cloud::Tasks::V2beta2::RetryConfig#max_backoff max_backoff} duration after it fails,
281
278
  # if the queue's {Google::Cloud::Tasks::V2beta2::RetryConfig RetryConfig} specifies that the task should be
@@ -284,8 +281,7 @@ module Google
284
281
  # If unspecified when the queue is created, Cloud Tasks will pick the
285
282
  # default.
286
283
  #
287
- # This field is output only for
288
- # [pull queues](https://cloud.google.comgoogle.cloud.tasks.v2beta2.PullTarget).
284
+ # This field is output only for {Google::Cloud::Tasks::V2beta2::PullTarget pull queues}.
289
285
  #
290
286
  #
291
287
  # +max_backoff+ will be truncated to the nearest second.
@@ -316,8 +312,7 @@ module Google
316
312
  # If unspecified when the queue is created, Cloud Tasks will pick the
317
313
  # default.
318
314
  #
319
- # This field is output only for
320
- # [pull queues](https://cloud.google.comgoogle.cloud.tasks.v2beta2.PullTarget).
315
+ # This field is output only for {Google::Cloud::Tasks::V2beta2::PullTarget pull queues}.
321
316
  #
322
317
  #
323
318
  # This field has the same meaning as
data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/target.rb CHANGED
@@ -148,7 +148,7 @@ module Google
148
148
  #
149
149
  # This map contains the header field names and values.
150
150
  # Headers can be set when the
151
- # [task is created](https://cloud.google.comgoogle.cloud.tasks.v2beta2.CloudTasks.CreateTask).
151
+ # {Google::Cloud::Tasks::V2beta2::CloudTasks::CreateTask task is created}.
152
152
  # Repeated headers are not supported but a header value can contain commas.
153
153
  #
154
154
  # Cloud Tasks sets some headers to default values:
@@ -165,7 +165,7 @@ module Google
165
165
  # * +Content-Type+: By default, the +Content-Type+ header is set to
166
166
  # +"application/octet-stream"+. The default can be overridden by explicitly
167
167
  # setting +Content-Type+ to a particular media type when the
168
- # [task is created](https://cloud.google.comgoogle.cloud.tasks.v2beta2.CloudTasks.CreateTask).
168
+ # {Google::Cloud::Tasks::V2beta2::CloudTasks::CreateTask task is created}.
169
169
  # For example, +Content-Type+ can be set to +"application/json"+.
170
170
  # * +Content-Length+: This is computed by Cloud Tasks. This value is
171
171
  # output only. It cannot be changed.
@@ -319,19 +319,19 @@ module Google
319
319
  # HTTP method unspecified
320
320
  HTTP_METHOD_UNSPECIFIED = 0
321
321
 
322
- # HTTP Post
322
+ # HTTP POST
323
323
  POST = 1
324
324
 
325
- # HTTP Get
325
+ # HTTP GET
326
326
  GET = 2
327
327
 
328
- # HTTP Head
328
+ # HTTP HEAD
329
329
  HEAD = 3
330
330
 
331
- # HTTP Put
331
+ # HTTP PUT
332
332
  PUT = 4
333
333
 
334
- # HTTP Delete
334
+ # HTTP DELETE
335
335
  DELETE = 5
336
336
  end
337
337
  end
data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/task.rb CHANGED
@@ -119,8 +119,7 @@ module Google
119
119
  # @return [Integer]
120
120
  # Output only. The number of attempts which have received a response.
121
121
  #
122
- # This field is not calculated for
123
- # [pull tasks](https://cloud.google.comgoogle.cloud.tasks.v2beta2.PullTaskTarget).
122
+ # This field is not calculated for {Google::Cloud::Tasks::V2beta2::PullMessage pull tasks}.
124
123
  # @!attribute [rw] first_attempt_status
125
124
  # @return [Google::Cloud::Tasks::V2beta2::AttemptStatus]
126
125
  # Output only. The status of the task's first attempt.
@@ -128,14 +127,12 @@ module Google
128
127
  # Only {Google::Cloud::Tasks::V2beta2::AttemptStatus#dispatch_time dispatch_time} will be set.
129
128
  # The other {Google::Cloud::Tasks::V2beta2::AttemptStatus AttemptStatus} information is not retained by Cloud Tasks.
130
129
  #
131
- # This field is not calculated for
132
- # [pull tasks](https://cloud.google.comgoogle.cloud.tasks.v2beta2.PullTaskTarget).
130
+ # This field is not calculated for {Google::Cloud::Tasks::V2beta2::PullMessage pull tasks}.
133
131
  # @!attribute [rw] last_attempt_status
134
132
  # @return [Google::Cloud::Tasks::V2beta2::AttemptStatus]
135
133
  # Output only. The status of the task's last attempt.
136
134
  #
137
- # This field is not calculated for
138
- # [pull tasks](https://cloud.google.comgoogle.cloud.tasks.v2beta2.PullTaskTarget).
135
+ # This field is not calculated for {Google::Cloud::Tasks::V2beta2::PullMessage pull tasks}.
139
136
  class TaskStatus; end
140
137
 
141
138
  # The status of a task attempt.
data/lib/google/cloud/tasks/v2beta2/doc/overview.rb CHANGED
@@ -29,7 +29,7 @@ module Google
29
29
  #
30
30
  # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
31
31
  # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
32
- # 3. [Enable the Cloud Tasks API.](https://console.cloud.google.com/apis/api/tasks)
32
+ # 3. [Enable the Cloud Tasks API.](https://console.cloud.google.com/apis/library/tasks.googleapis.com)
33
33
  # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
34
34
  #
35
35
  # ### Installation
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-tasks
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.1
4
+ version: 0.2.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-07-05 00:00:00.000000000 Z
11
+ date: 2018-08-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-gax
@@ -52,6 +52,20 @@ dependencies:
52
52
  - - "~>"
53
53
  - !ruby/object:Gem::Version
54
54
  version: '5.10'
55
+ - !ruby/object:Gem::Dependency
56
+ name: redcarpet
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.0'
55
69
  - !ruby/object:Gem::Dependency
56
70
  name: rubocop
57
71
  requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
80
94
  - - "~>"
81
95
  - !ruby/object:Gem::Version
82
96
  version: '0.9'
97
+ - !ruby/object:Gem::Dependency
98
+ name: yard
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: '0.9'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '0.9'
83
111
  description: google-cloud-tasks is the official library for Cloud Tasks API.
84
112
  email: googleapis-packages@google.com
85
113
  executables: []
@@ -112,7 +140,7 @@ files:
112
140
  - lib/google/cloud/tasks/v2beta2/queue_pb.rb
113
141
  - lib/google/cloud/tasks/v2beta2/target_pb.rb
114
142
  - lib/google/cloud/tasks/v2beta2/task_pb.rb
115
- homepage: https://github.com/googleapis/googleapis
143
+ homepage: https://github.com/GoogleCloudPlatform/google-cloud-ruby/tree/master/google-cloud-tasks
116
144
  licenses:
117
145
  - Apache-2.0
118
146
  metadata: {}