google-cloud-scheduler-v1beta1 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c45707ab9bc7051624f6c251b8318b68abe9b9a13712ced24f7e77e19260e833
-  data.tar.gz: a8fac14d2939ba3319a10fd7e34b7b0e56fb3b17cb9d29eb16e6e54bdd522c00
+  metadata.gz: 501a441332a8fc230e77a49ccf0868488717063acde66f7d7848de56868f7eca
+  data.tar.gz: 54a8b7266e244ed451174909e698c878f8704f44a0ae2d49d4e27c6aaaba1943
 SHA512:
-  metadata.gz: 3f89faf251e370f355af1aac0d1bcdd496d8dca2ce6d498189d53356d2f98b4fe75a3c6f72816ca99e0938612c8e8674514d9ae0ea21e571714c5615127ac227
-  data.tar.gz: c7899d9dcb058f7fbb13a6136c9cdadf92103f4974dfe0f2c59e033f945af680c8a85248a381fb1499c0cacffb5e13c6b07967287350534b3fcee0b11971b8b8
+  metadata.gz: f0da5e60e24246003452d31d98a32c2187d4919cde0d9cb8651d34da3dd471ba058c20da0db2eed50fbcbe956e36906850de609d5f02ab82161946bec232c0dd
+  data.tar.gz: 73eb8205d6147fa454621c6f41d683fc091dd7137a0d6e959f5b19f555e01e5052da2a111c10576828f66c00dd816e52032323a165bdf0a92a59175adb8f9f69

data/AUTHENTICATION.md

@@ -114,7 +114,7 @@ credentials are discovered.
 To configure your system for this, simply:
 
 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
-2. Authenticate using OAuth 2.0 `$ gcloud auth login`
+2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
 3. Write code as if already authenticated.
 
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK

data/README.md

@@ -46,7 +46,7 @@ for general usage information.
 ## Enabling Logging
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
 or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
 that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
 and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.

data/lib/google/cloud/scheduler/v1beta1/cloud_scheduler/client.rb

@@ -18,6 +18,7 @@
 
 require "google/cloud/errors"
 require "google/cloud/scheduler/v1beta1/cloudscheduler_pb"
+require "google/cloud/location"
 
 module Google
   module Cloud
@@ -165,6 +166,12 @@ module Google
               @quota_project_id = @config.quota_project
               @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
+              @location_client = Google::Cloud::Location::Locations::Client.new do |config|
+                config.credentials = credentials
+                config.quota_project = @quota_project_id
+                config.endpoint = @config.endpoint
+              end
+
               @cloud_scheduler_stub = ::Gapic::ServiceStub.new(
                 ::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Stub,
                 credentials:  credentials,
@@ -174,6 +181,13 @@ module Google
               )
             end
 
+            ##
+            # Get the associated client for mix-in of the Locations.
+            #
+            # @return [Google::Cloud::Location::Locations::Client]
+            #
+            attr_reader :location_client
+
             # Service calls
 
             ##
@@ -189,7 +203,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload list_jobs(parent: nil, page_size: nil, page_token: nil)
+            # @overload list_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, legacy_app_engine_cron: nil)
             #   Pass arguments to `list_jobs` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -197,6 +211,15 @@ module Google
             #   @param parent [::String]
             #     Required. The location name. For example:
             #     `projects/PROJECT_ID/locations/LOCATION_ID`.
+            #   @param filter [::String]
+            #     `filter` can be used to specify a subset of jobs.
+            #
+            #     If `filter` equals `target_config="HttpConfig"`, then the http
+            #     target jobs are retrieved. If `filter` equals
+            #     `target_config="PubSubConfig"`, then the Pub/Sub target jobs are
+            #     retrieved. If `filter` equals `labels.foo=value1
+            #     labels.foo=value2` then only jobs which are labeled with
+            #     foo=value1 AND foo=value2 will be returned.
             #   @param page_size [::Integer]
             #     Requested page size.
             #
@@ -208,10 +231,17 @@ module Google
             #     A token identifying a page of results the server will return. To
             #     request the first page results, page_token must be empty. To
             #     request the next page of results, page_token must be the value of
-            #     {::Google::Cloud::Scheduler::V1beta1::ListJobsResponse#next_page_token next_page_token} returned from
-            #     the previous call to {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#list_jobs ListJobs}. It is an error to
-            #     switch the value of [filter][google.cloud.scheduler.v1beta1.ListJobsRequest.filter] or
-            #     [order_by][google.cloud.scheduler.v1beta1.ListJobsRequest.order_by] while iterating through pages.
+            #     {::Google::Cloud::Scheduler::V1beta1::ListJobsResponse#next_page_token next_page_token}
+            #     returned from the previous call to
+            #     {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#list_jobs ListJobs}. It is
+            #     an error to switch the value of
+            #     {::Google::Cloud::Scheduler::V1beta1::ListJobsRequest#filter filter} or
+            #     [order_by][google.cloud.scheduler.v1beta1.ListJobsRequest.order_by] while
+            #     iterating through pages.
+            #   @param legacy_app_engine_cron [::Boolean]
+            #     This field is used to manage the legacy App Engine Cron jobs using the
+            #     Cloud Scheduler API. If the field is set to true, the jobs in the __cron
+            #     queue will be listed instead.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Scheduler::V1beta1::Job>]
@@ -393,7 +423,8 @@ module Google
             #     `projects/PROJECT_ID/locations/LOCATION_ID`.
             #   @param job [::Google::Cloud::Scheduler::V1beta1::Job, ::Hash]
             #     Required. The job to add. The user can optionally specify a name for the
-            #     job in {::Google::Cloud::Scheduler::V1beta1::Job#name name}. {::Google::Cloud::Scheduler::V1beta1::Job#name name} cannot be the same as an
+            #     job in {::Google::Cloud::Scheduler::V1beta1::Job#name name}.
+            #     {::Google::Cloud::Scheduler::V1beta1::Job#name name} cannot be the same as an
             #     existing job. If a name is not specified then the system will
             #     generate a random unique name that will be returned
             #     ({::Google::Cloud::Scheduler::V1beta1::Job#name name}) in the response.
@@ -465,13 +496,14 @@ module Google
             ##
             # Updates a job.
             #
-            # If successful, the updated {::Google::Cloud::Scheduler::V1beta1::Job Job} is returned. If the job does
-            # not exist, `NOT_FOUND` is returned.
+            # If successful, the updated {::Google::Cloud::Scheduler::V1beta1::Job Job} is
+            # returned. If the job does not exist, `NOT_FOUND` is returned.
             #
             # If UpdateJob does not successfully return, it is possible for the
-            # job to be in an {::Google::Cloud::Scheduler::V1beta1::Job::State::UPDATE_FAILED Job.State.UPDATE_FAILED} state. A job in this state may
-            # not be executed. If this happens, retry the UpdateJob request
-            # until a successful response is received.
+            # job to be in an
+            # {::Google::Cloud::Scheduler::V1beta1::Job::State::UPDATE_FAILED Job.State.UPDATE_FAILED}
+            # state. A job in this state may not be executed. If this happens, retry the
+            # UpdateJob request until a successful response is received.
             #
             # @overload update_job(request, options = nil)
             #   Pass arguments to `update_job` via a request object, either of type
@@ -489,7 +521,8 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param job [::Google::Cloud::Scheduler::V1beta1::Job, ::Hash]
-            #     Required. The new job properties. {::Google::Cloud::Scheduler::V1beta1::Job#name name} must be specified.
+            #     Required. The new job properties.
+            #     {::Google::Cloud::Scheduler::V1beta1::Job#name name} must be specified.
             #
             #     Output only fields cannot be modified using UpdateJob.
             #     Any value specified for an output only field will be ignored.
@@ -573,7 +606,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload delete_job(name: nil)
+            # @overload delete_job(name: nil, legacy_app_engine_cron: nil)
             #   Pass arguments to `delete_job` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -581,6 +614,10 @@ module Google
             #   @param name [::String]
             #     Required. The job name. For example:
             #     `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
+            #   @param legacy_app_engine_cron [::Boolean]
+            #     This field is used to manage the legacy App Engine Cron jobs using the
+            #     Cloud Scheduler API. If the field is set to true, the job in the __cron
+            #     queue with the corresponding name will be deleted instead.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Protobuf::Empty]
@@ -650,10 +687,14 @@ module Google
             # Pauses a job.
             #
             # If a job is paused then the system will stop executing the job
-            # until it is re-enabled via {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#resume_job ResumeJob}. The
-            # state of the job is stored in {::Google::Cloud::Scheduler::V1beta1::Job#state state}; if paused it
-            # will be set to {::Google::Cloud::Scheduler::V1beta1::Job::State::PAUSED Job.State.PAUSED}. A job must be in {::Google::Cloud::Scheduler::V1beta1::Job::State::ENABLED Job.State.ENABLED}
-            # to be paused.
+            # until it is re-enabled via
+            # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#resume_job ResumeJob}. The
+            # state of the job is stored in
+            # {::Google::Cloud::Scheduler::V1beta1::Job#state state}; if paused it will be set
+            # to {::Google::Cloud::Scheduler::V1beta1::Job::State::PAUSED Job.State.PAUSED}. A
+            # job must be in
+            # {::Google::Cloud::Scheduler::V1beta1::Job::State::ENABLED Job.State.ENABLED} to be
+            # paused.
             #
             # @overload pause_job(request, options = nil)
             #   Pass arguments to `pause_job` via a request object, either of type
@@ -741,10 +782,15 @@ module Google
             ##
             # Resume a job.
             #
-            # This method reenables a job after it has been {::Google::Cloud::Scheduler::V1beta1::Job::State::PAUSED Job.State.PAUSED}. The
-            # state of a job is stored in {::Google::Cloud::Scheduler::V1beta1::Job#state Job.state}; after calling this method it
-            # will be set to {::Google::Cloud::Scheduler::V1beta1::Job::State::ENABLED Job.State.ENABLED}. A job must be in
-            # {::Google::Cloud::Scheduler::V1beta1::Job::State::PAUSED Job.State.PAUSED} to be resumed.
+            # This method reenables a job after it has been
+            # {::Google::Cloud::Scheduler::V1beta1::Job::State::PAUSED Job.State.PAUSED}. The
+            # state of a job is stored in
+            # {::Google::Cloud::Scheduler::V1beta1::Job#state Job.state}; after calling this
+            # method it will be set to
+            # {::Google::Cloud::Scheduler::V1beta1::Job::State::ENABLED Job.State.ENABLED}. A
+            # job must be in
+            # {::Google::Cloud::Scheduler::V1beta1::Job::State::PAUSED Job.State.PAUSED} to be
+            # resumed.
             #
             # @overload resume_job(request, options = nil)
             #   Pass arguments to `resume_job` via a request object, either of type
@@ -845,7 +891,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload run_job(name: nil)
+            # @overload run_job(name: nil, legacy_app_engine_cron: nil)
             #   Pass arguments to `run_job` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -853,6 +899,10 @@ module Google
             #   @param name [::String]
             #     Required. The job name. For example:
             #     `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
+            #   @param legacy_app_engine_cron [::Boolean]
+            #     This field is used to manage the legacy App Engine Cron jobs using the
+            #     Cloud Scheduler API. If the field is set to true, the job in the __cron
+            #     queue with the corresponding name will be forced to run instead.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Scheduler::V1beta1::Job]

data/lib/google/cloud/scheduler/v1beta1/cloudscheduler_pb.rb

@@ -15,8 +15,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/scheduler/v1beta1/cloudscheduler.proto", :syntax => :proto3) do
     add_message "google.cloud.scheduler.v1beta1.ListJobsRequest" do
       optional :parent, :string, 1
+      optional :filter, :string, 4
       optional :page_size, :int32, 5
       optional :page_token, :string, 6
+      optional :legacy_app_engine_cron, :bool, 7
     end
     add_message "google.cloud.scheduler.v1beta1.ListJobsResponse" do
       repeated :jobs, :message, 1, "google.cloud.scheduler.v1beta1.Job"
@@ -35,6 +37,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.cloud.scheduler.v1beta1.DeleteJobRequest" do
       optional :name, :string, 1
+      optional :legacy_app_engine_cron, :bool, 2
     end
     add_message "google.cloud.scheduler.v1beta1.PauseJobRequest" do
       optional :name, :string, 1
@@ -44,6 +47,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.cloud.scheduler.v1beta1.RunJobRequest" do
       optional :name, :string, 1
+      optional :legacy_app_engine_cron, :bool, 2
     end
   end
 end

data/lib/google/cloud/scheduler/v1beta1/cloudscheduler_services_pb.rb

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/cloud/scheduler/v1beta1/cloudscheduler.proto for package 'google.cloud.scheduler.v1beta1'
 # Original file comments:
-# Copyright 2019 Google LLC.
+# Copyright 2022 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-#
 
 require 'grpc'
 require 'google/cloud/scheduler/v1beta1/cloudscheduler_pb'
@@ -43,30 +42,40 @@ module Google
             rpc :CreateJob, ::Google::Cloud::Scheduler::V1beta1::CreateJobRequest, ::Google::Cloud::Scheduler::V1beta1::Job
             # Updates a job.
             #
-            # If successful, the updated [Job][google.cloud.scheduler.v1beta1.Job] is returned. If the job does
-            # not exist, `NOT_FOUND` is returned.
+            # If successful, the updated [Job][google.cloud.scheduler.v1beta1.Job] is
+            # returned. If the job does not exist, `NOT_FOUND` is returned.
             #
             # If UpdateJob does not successfully return, it is possible for the
-            # job to be in an [Job.State.UPDATE_FAILED][google.cloud.scheduler.v1beta1.Job.State.UPDATE_FAILED] state. A job in this state may
-            # not be executed. If this happens, retry the UpdateJob request
-            # until a successful response is received.
+            # job to be in an
+            # [Job.State.UPDATE_FAILED][google.cloud.scheduler.v1beta1.Job.State.UPDATE_FAILED]
+            # state. A job in this state may not be executed. If this happens, retry the
+            # UpdateJob request until a successful response is received.
             rpc :UpdateJob, ::Google::Cloud::Scheduler::V1beta1::UpdateJobRequest, ::Google::Cloud::Scheduler::V1beta1::Job
             # Deletes a job.
             rpc :DeleteJob, ::Google::Cloud::Scheduler::V1beta1::DeleteJobRequest, ::Google::Protobuf::Empty
             # Pauses a job.
             #
             # If a job is paused then the system will stop executing the job
-            # until it is re-enabled via [ResumeJob][google.cloud.scheduler.v1beta1.CloudScheduler.ResumeJob]. The
-            # state of the job is stored in [state][google.cloud.scheduler.v1beta1.Job.state]; if paused it
-            # will be set to [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. A job must be in [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED]
-            # to be paused.
+            # until it is re-enabled via
+            # [ResumeJob][google.cloud.scheduler.v1beta1.CloudScheduler.ResumeJob]. The
+            # state of the job is stored in
+            # [state][google.cloud.scheduler.v1beta1.Job.state]; if paused it will be set
+            # to [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. A
+            # job must be in
+            # [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED] to be
+            # paused.
             rpc :PauseJob, ::Google::Cloud::Scheduler::V1beta1::PauseJobRequest, ::Google::Cloud::Scheduler::V1beta1::Job
             # Resume a job.
             #
-            # This method reenables a job after it has been [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. The
-            # state of a job is stored in [Job.state][google.cloud.scheduler.v1beta1.Job.state]; after calling this method it
-            # will be set to [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED]. A job must be in
-            # [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED] to be resumed.
+            # This method reenables a job after it has been
+            # [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. The
+            # state of a job is stored in
+            # [Job.state][google.cloud.scheduler.v1beta1.Job.state]; after calling this
+            # method it will be set to
+            # [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED]. A
+            # job must be in
+            # [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED] to be
+            # resumed.
             rpc :ResumeJob, ::Google::Cloud::Scheduler::V1beta1::ResumeJobRequest, ::Google::Cloud::Scheduler::V1beta1::Job
             # Forces a job to run now.
             #

data/lib/google/cloud/scheduler/v1beta1/job_pb.rb

@@ -3,12 +3,12 @@
 
 require 'google/protobuf'
 
+require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/scheduler/v1beta1/target_pb'
 require 'google/protobuf/duration_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/rpc/status_pb'
-require 'google/api/annotations_pb'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/scheduler/v1beta1/job.proto", :syntax => :proto3) do
@@ -24,6 +24,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :last_attempt_time, :message, 18, "google.protobuf.Timestamp"
       optional :retry_config, :message, 19, "google.cloud.scheduler.v1beta1.RetryConfig"
       optional :attempt_deadline, :message, 22, "google.protobuf.Duration"
+      optional :legacy_app_engine_cron, :bool, 23
       oneof :target do
         optional :pubsub_target, :message, 4, "google.cloud.scheduler.v1beta1.PubsubTarget"
         optional :app_engine_http_target, :message, 5, "google.cloud.scheduler.v1beta1.AppEngineHttpTarget"

data/lib/google/cloud/scheduler/v1beta1/target_pb.rb

@@ -4,7 +4,6 @@
 require 'google/protobuf'
 
 require 'google/api/resource_pb'
-require 'google/api/annotations_pb'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/scheduler/v1beta1/target.proto", :syntax => :proto3) do

data/lib/google/cloud/scheduler/v1beta1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Scheduler
       module V1beta1
-        VERSION = "0.5.0"
+        VERSION = "0.6.0"
       end
     end
   end