google-cloud-scheduler-v1beta1 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c45707ab9bc7051624f6c251b8318b68abe9b9a13712ced24f7e77e19260e833
-  data.tar.gz: a8fac14d2939ba3319a10fd7e34b7b0e56fb3b17cb9d29eb16e6e54bdd522c00
+  metadata.gz: 51b3fe6586de7a140411daaf1ee4639e8593175e1c76c1817e7b7553be80e37a
+  data.tar.gz: 38c759fb516a5ce01c2af36b1bd2b0bf0413db07080320b07c59eb1dc73ee02a
 SHA512:
-  metadata.gz: 3f89faf251e370f355af1aac0d1bcdd496d8dca2ce6d498189d53356d2f98b4fe75a3c6f72816ca99e0938612c8e8674514d9ae0ea21e571714c5615127ac227
-  data.tar.gz: c7899d9dcb058f7fbb13a6136c9cdadf92103f4974dfe0f2c59e033f945af680c8a85248a381fb1499c0cacffb5e13c6b07967287350534b3fcee0b11971b8b8
+  metadata.gz: 24b09d7c1c2a27564287ffe0047494971271ab143f91a6823e698b06982f38f22a4b46d9fd2b577f7adb9b98c22ff598b991f531ca081c55fa800afac3d34092
+  data.tar.gz: 8825f6c915f0e3ecada7abe627ce78d51c44a336dc42bd67905ca0ec13137e4ac8378a1f68478b7b268370eba896c6659e3a4e6878dfd8e41261ec83a7d07a32

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

@@ -1,6 +1,6 @@
 # Ruby Client for the Cloud Scheduler V1beta1 API
 
-API Client library for the Cloud Scheduler V1beta1 API
+Creates and manages jobs run on a regular recurring schedule.
 
 Cloud Scheduler is a fully managed enterprise-grade cron job scheduler. It allows you to schedule virtually any job, including batch, big data jobs, cloud infrastructure operations, and more. You can automate everything, including retries in case of failure to reduce manual toil and intervention. Cloud Scheduler even acts as a single pane of glass, allowing you to manage all your automation tasks from one place.
 
@@ -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/bindings_override.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/config"
+
+module Google
+  module Cloud
+    module Scheduler
+      ##
+      # @example Loading just the REST part of this package, including all its services, and instantiating a REST client
+      #
+      #     require "google/cloud/scheduler/v1beta1/rest"
+      #     client = ::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Rest::Client.new
+      #
+      module V1beta1
+        ##
+        # @private
+        # Initialize the mixin bindings configuration
+        #
+        def self.configure
+          @configure ||= begin
+            namespace = ["Google", "Cloud", "Scheduler"]
+            parent_config = while namespace.any?
+                              parent_name = namespace.join "::"
+                              parent_const = const_get parent_name
+                              break parent_const.configure if parent_const.respond_to? :configure
+                              namespace.pop
+                            end
+
+            default_config = Configuration.new parent_config
+            default_config.bindings_override["google.cloud.location.Locations.GetLocation"] = [
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :get,
+                uri_template: "/v1beta1/{name}",
+                matches: [
+                  ["name", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
+                ],
+                body: nil
+              )
+            ]
+            default_config.bindings_override["google.cloud.location.Locations.ListLocations"] = [
+
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :get,
+                uri_template: "/v1beta1/{name}/locations",
+                matches: [
+                  ["name", %r{^projects/[^/]+/?$}, false]
+                ],
+                body: nil
+              )
+            ]
+            default_config
+          end
+          yield @configure if block_given?
+          @configure
+        end
+
+        ##
+        # @private
+        # Configuration class for the google.cloud.scheduler.v1beta1 package.
+        #
+        # This class contains common configuration for all services
+        # of the google.cloud.scheduler.v1beta1 package.
+        #
+        # This configuration is for internal use of the client library classes,
+        # and it is not intended that the end-users will read or change it.
+        #
+        class Configuration
+          extend ::Gapic::Config
+
+          # @private
+          # Overrides for http bindings for the RPC of the mixins for this package.
+          # Services in this package should use these when creating clients for the mixin services.
+          # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
+          config_attr :bindings_override, {}, ::Hash, nil
+
+          # @private
+          def initialize parent_config = nil
+            @parent_config = parent_config unless parent_config.nil?
+
+            yield self if block_given?
+          end
+        end
+      end
+    end
+  end
+end

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>]
@@ -233,13 +263,11 @@ module Google
             #   # Call the list_jobs method.
             #   result = client.list_jobs request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Cloud::Scheduler::V1beta1::Job.
-            #     p response
+            #     p item
             #   end
             #
             def list_jobs request, options = nil
@@ -393,7 +421,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 +494,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 +519,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 +604,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 +612,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 +685,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 +780,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 +889,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 +897,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]