google-cloud-scheduler-v1 0.4.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89d621605aeef7b6822bfd01949acd069f7921b3492598b40c4b31d1a0bff079
-  data.tar.gz: ea61cd81c34c3e412f6b668536b4e865f21533cbd919c9daf0097457432f626e
+  metadata.gz: 44a906b54e0e36764993fcac04af6dd2a9c2eb63fc50c3b3199f9134b541741a
+  data.tar.gz: cbae72abe1596ceb929b9f722f4e209ce0656d1ef8c05838e4380d4a895d3803
 SHA512:
-  metadata.gz: a30e0e370a54d8d202f3aaeb84faeb11234ca83d8bd5f666a1b66fd2ac52c96905e9b4f453c714bc56496bc6c99156581dcef6a084230786b39096bbe8fe17e4
-  data.tar.gz: 04f1d01cd1f4ecd233d63b26a4f07290a2b84c890099e6e00cab3ad6c97b027f3f9f3de071ed941a1935285d7c6aff818453baa25e3735bc9c9553907042699a
+  metadata.gz: 658f3ac3c788acbbfb338eec570c23a6f3cda149c2410ef30b4612c698d35250265c41a56924d343e7f3038cc90d9403f36ed73e3ccd2c0982f33fd6c5a76b25
+  data.tar.gz: 98bc35f2055aae27fe7914b6c9650d3d32799f797596e29f1532ecbf3c18b68271648081a98d70d298dc74ce9c9dc15df7de2a3f3ad2079f918e9eee53b1d2e0

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 V1 API
 
-API Client library for the Cloud Scheduler V1 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.
 
@@ -37,7 +37,7 @@ request = ::Google::Cloud::Scheduler::V1::ListJobsRequest.new # (request fields
 response = client.list_jobs request
 ```
 
-View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-scheduler-v1/latest)
+View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-scheduler-v1/latest)
 for class and method documentation.
 
 See also the [Product Documentation](https://cloud.google.com/scheduler)
@@ -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.
@@ -69,16 +69,21 @@ module GRPC
 end
 ```
 
+
+## Google Cloud Samples
+
+To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
+
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.5+.
+This library is supported on Ruby 2.6+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or
-in security maintenance, and not end of life. Currently, this means Ruby 2.5
-and later. Older versions of Ruby _may_ still work, but are unsupported and not
-recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
-about the Ruby support schedule.
+in security maintenance, and not end of life. Older versions of Ruby _may_
+still work, but are unsupported and not recommended. See
+https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
+support schedule.
 
 ## Which client should I use?
 

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

@@ -18,6 +18,7 @@
 
 require "google/cloud/errors"
 require "google/cloud/scheduler/v1/cloudscheduler_pb"
+require "google/cloud/location"
 
 module Google
   module Cloud
@@ -159,6 +160,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::V1::CloudScheduler::Stub,
                 credentials:  credentials,
@@ -168,6 +175,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
 
             ##
@@ -202,10 +216,13 @@ 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::V1::ListJobsResponse#next_page_token next_page_token} returned from
-            #     the previous call to {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#list_jobs ListJobs}. It is an error to
-            #     switch the value of [filter][google.cloud.scheduler.v1.ListJobsRequest.filter] or
-            #     [order_by][google.cloud.scheduler.v1.ListJobsRequest.order_by] while iterating through pages.
+            #     {::Google::Cloud::Scheduler::V1::ListJobsResponse#next_page_token next_page_token}
+            #     returned from the previous call to
+            #     {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#list_jobs ListJobs}. It is an
+            #     error to switch the value of
+            #     [filter][google.cloud.scheduler.v1.ListJobsRequest.filter] or
+            #     [order_by][google.cloud.scheduler.v1.ListJobsRequest.order_by] while
+            #     iterating through pages.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Scheduler::V1::Job>]
@@ -227,13 +244,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::V1::Job.
-            #     p response
+            #     p item
             #   end
             #
             def list_jobs request, options = nil
@@ -387,7 +402,8 @@ module Google
             #     `projects/PROJECT_ID/locations/LOCATION_ID`.
             #   @param job [::Google::Cloud::Scheduler::V1::Job, ::Hash]
             #     Required. The job to add. The user can optionally specify a name for the
-            #     job in {::Google::Cloud::Scheduler::V1::Job#name name}. {::Google::Cloud::Scheduler::V1::Job#name name} cannot be the same as an
+            #     job in {::Google::Cloud::Scheduler::V1::Job#name name}.
+            #     {::Google::Cloud::Scheduler::V1::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::V1::Job#name name}) in the response.
@@ -459,13 +475,14 @@ module Google
             ##
             # Updates a job.
             #
-            # If successful, the updated {::Google::Cloud::Scheduler::V1::Job Job} is returned. If the job does
-            # not exist, `NOT_FOUND` is returned.
+            # If successful, the updated {::Google::Cloud::Scheduler::V1::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::V1::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::V1::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
@@ -483,7 +500,8 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param job [::Google::Cloud::Scheduler::V1::Job, ::Hash]
-            #     Required. The new job properties. {::Google::Cloud::Scheduler::V1::Job#name name} must be specified.
+            #     Required. The new job properties.
+            #     {::Google::Cloud::Scheduler::V1::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.
@@ -644,10 +662,13 @@ 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::V1::CloudScheduler::Client#resume_job ResumeJob}. The
-            # state of the job is stored in {::Google::Cloud::Scheduler::V1::Job#state state}; if paused it
-            # will be set to {::Google::Cloud::Scheduler::V1::Job::State::PAUSED Job.State.PAUSED}. A job must be in {::Google::Cloud::Scheduler::V1::Job::State::ENABLED Job.State.ENABLED}
-            # to be paused.
+            # until it is re-enabled via
+            # {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#resume_job ResumeJob}. The state
+            # of the job is stored in {::Google::Cloud::Scheduler::V1::Job#state state}; if
+            # paused it will be set to
+            # {::Google::Cloud::Scheduler::V1::Job::State::PAUSED Job.State.PAUSED}. A job must
+            # be in {::Google::Cloud::Scheduler::V1::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
@@ -735,10 +756,13 @@ module Google
             ##
             # Resume a job.
             #
-            # This method reenables a job after it has been {::Google::Cloud::Scheduler::V1::Job::State::PAUSED Job.State.PAUSED}. The
-            # state of a job is stored in {::Google::Cloud::Scheduler::V1::Job#state Job.state}; after calling this method it
-            # will be set to {::Google::Cloud::Scheduler::V1::Job::State::ENABLED Job.State.ENABLED}. A job must be in
-            # {::Google::Cloud::Scheduler::V1::Job::State::PAUSED Job.State.PAUSED} to be resumed.
+            # This method reenables a job after it has been
+            # {::Google::Cloud::Scheduler::V1::Job::State::PAUSED Job.State.PAUSED}. The state
+            # of a job is stored in {::Google::Cloud::Scheduler::V1::Job#state Job.state};
+            # after calling this method it will be set to
+            # {::Google::Cloud::Scheduler::V1::Job::State::ENABLED Job.State.ENABLED}. A job
+            # must be in {::Google::Cloud::Scheduler::V1::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

data/lib/google/cloud/scheduler/v1/cloud_scheduler.rb

@@ -34,7 +34,7 @@ module Google
         # The Cloud Scheduler API allows external entities to reliably
         # schedule asynchronous jobs.
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/scheduler/v1/cloud_scheduler"
         #     client = ::Google::Cloud::Scheduler::V1::CloudScheduler::Client.new

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

@@ -1,6 +1,8 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/scheduler/v1/cloudscheduler.proto
 
+require 'google/protobuf'
+
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
@@ -8,7 +10,6 @@ require 'google/api/resource_pb'
 require 'google/cloud/scheduler/v1/job_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
-require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/scheduler/v1/cloudscheduler.proto", :syntax => :proto3) do

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

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/cloud/scheduler/v1/cloudscheduler.proto for package 'google.cloud.scheduler.v1'
 # 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/v1/cloudscheduler_pb'
@@ -43,30 +42,37 @@ module Google
             rpc :CreateJob, ::Google::Cloud::Scheduler::V1::CreateJobRequest, ::Google::Cloud::Scheduler::V1::Job
             # Updates a job.
             #
-            # If successful, the updated [Job][google.cloud.scheduler.v1.Job] is returned. If the job does
-            # not exist, `NOT_FOUND` is returned.
+            # If successful, the updated [Job][google.cloud.scheduler.v1.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.v1.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.v1.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::V1::UpdateJobRequest, ::Google::Cloud::Scheduler::V1::Job
             # Deletes a job.
             rpc :DeleteJob, ::Google::Cloud::Scheduler::V1::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.v1.CloudScheduler.ResumeJob]. The
-            # state of the job is stored in [state][google.cloud.scheduler.v1.Job.state]; if paused it
-            # will be set to [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]. A job must be in [Job.State.ENABLED][google.cloud.scheduler.v1.Job.State.ENABLED]
-            # to be paused.
+            # until it is re-enabled via
+            # [ResumeJob][google.cloud.scheduler.v1.CloudScheduler.ResumeJob]. The state
+            # of the job is stored in [state][google.cloud.scheduler.v1.Job.state]; if
+            # paused it will be set to
+            # [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]. A job must
+            # be in [Job.State.ENABLED][google.cloud.scheduler.v1.Job.State.ENABLED] to
+            # be paused.
             rpc :PauseJob, ::Google::Cloud::Scheduler::V1::PauseJobRequest, ::Google::Cloud::Scheduler::V1::Job
             # Resume a job.
             #
-            # This method reenables a job after it has been [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]. The
-            # state of a job is stored in [Job.state][google.cloud.scheduler.v1.Job.state]; after calling this method it
-            # will be set to [Job.State.ENABLED][google.cloud.scheduler.v1.Job.State.ENABLED]. A job must be in
-            # [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED] to be resumed.
+            # This method reenables a job after it has been
+            # [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]. The state
+            # of a job is stored in [Job.state][google.cloud.scheduler.v1.Job.state];
+            # after calling this method it will be set to
+            # [Job.State.ENABLED][google.cloud.scheduler.v1.Job.State.ENABLED]. A job
+            # must be in [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]
+            # to be resumed.
             rpc :ResumeJob, ::Google::Cloud::Scheduler::V1::ResumeJobRequest, ::Google::Cloud::Scheduler::V1::Job
             # Forces a job to run now.
             #

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

@@ -1,13 +1,13 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/scheduler/v1/job.proto
 
+require 'google/protobuf'
+
 require 'google/api/resource_pb'
 require 'google/cloud/scheduler/v1/target_pb'
 require 'google/protobuf/duration_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/rpc/status_pb'
-require 'google/api/annotations_pb'
-require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/scheduler/v1/job.proto", :syntax => :proto3) do

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

@@ -1,10 +1,10 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/scheduler/v1/target.proto
 
-require 'google/api/resource_pb'
-require 'google/api/annotations_pb'
 require 'google/protobuf'
 
+require 'google/api/resource_pb'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/scheduler/v1/target.proto", :syntax => :proto3) do
     add_message "google.cloud.scheduler.v1.HttpTarget" do

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Scheduler
       module V1
-        VERSION = "0.4.5"
+        VERSION = "0.6.0"
       end
     end
   end

data/lib/google/cloud/scheduler/v1.rb

@@ -23,7 +23,9 @@ module Google
   module Cloud
     module Scheduler
       ##
-      # To load this package, including all its services, and instantiate a client:
+      # API client module.
+      #
+      # @example Load this package, including all its services, and instantiate a gRPC client
       #
       #     require "google/cloud/scheduler/v1"
       #     client = ::Google::Cloud::Scheduler::V1::CloudScheduler::Client.new