google-cloud-scheduler 2.7.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c160a91e57c8d23f266a015519e3b306c6bac3dec6827b7b7996fbef9a512a7
-  data.tar.gz: 6b2a5636c03b3433385d5e6f18a01b61cf28c5b6ea519dab74444f115bf83449
+  metadata.gz: 146e7b2e2ba3614b4c1b4de905b10e3ea675e36f06f500b4734b6d68d8ca081a
+  data.tar.gz: 6ed470bb638760e06a0bae4928e8031928e852e5b6e21948f69e2c92d2b483b0
 SHA512:
-  metadata.gz: 2ba262a4d7d20e39b8905574b61e6a31059f1312aebde2bfb01054245e435059a78d3a41f39a9d95f14ced204ed69b65f0221b3d90c3c5ad50a54ec50834f630
-  data.tar.gz: acb5db41c92bbd293487c2c91030b5fad0f12c0026ef4c631499174f9e5b2e17214662aff2af88dbd9bdb27e4d00a792fb2b8fec6f35d2892c66a5c54911baae
+  metadata.gz: 21d00a7319bb4ec0e4ebfb0c67c9c4754e3d2a42b9112128f539c49609f0422f7d21f66716e267d20c521b71201215cf2123df79a9458ab527b3f4e8f101c961
+  data.tar.gz: 97700ee580056c9814d2f38e2ee3b239a2df510156d46e559fa64772607f79f4c25176f64fd905bf69b23f471dd3842d52f634f0547b3401af99fc72fe59042c

data/.yardopts

@@ -8,5 +8,4 @@
 -
 README.md
 AUTHENTICATION.md
-MIGRATING.md
 LICENSE.md

data/README.md

@@ -16,8 +16,7 @@ for this library, google-cloud-scheduler, to see the convenience methods for
 constructing client objects. Reference documentation for the client objects
 themselves can be found in the client library documentation for the versioned
 client gems:
-[google-cloud-scheduler-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-scheduler-v1/latest),
-[google-cloud-scheduler-v1beta1](https://cloud.google.com/ruby/docs/reference/google-cloud-scheduler-v1beta1/latest).
+[google-cloud-scheduler-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-scheduler-v1/latest).
 
 See also the [Product Documentation](https://cloud.google.com/scheduler)
 for more usage information.
@@ -35,14 +34,6 @@ In order to use this library, you first need to go through the following steps:
 1. [Enable the API.](https://console.cloud.google.com/apis/library/cloudscheduler.googleapis.com)
 1. {file:AUTHENTICATION.md Set up authentication.}
 
-## Migrating from 1.x versions
-
-The 2.0 release of the google-cloud-scheduler client is a significant upgrade
-based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-ruby),
-and includes substantial interface changes. Existing code written for earlier
-versions of this library will likely require updates to use this version.
-See the {file:MIGRATING.md MIGRATING.md} document for more information.
-
 ## Debug Logging
 
 This library comes with opt-in Debug Logging that can help you troubleshoot
@@ -71,8 +62,7 @@ results in logs appearing alongside your application logs in the
 Debug logging also requires that the versioned clients for this service be
 sufficiently recent, released after about Dec 10, 2024. If logging is not
 working, try updating the versioned clients in your bundle or installed gems:
-[google-cloud-scheduler-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-scheduler-v1/latest),
-[google-cloud-scheduler-v1beta1](https://cloud.google.com/ruby/docs/reference/google-cloud-scheduler-v1beta1/latest).
+[google-cloud-scheduler-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-scheduler-v1/latest).
 
 ## Supported Ruby Versions
 

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

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module Scheduler
-      VERSION = "2.7.0"
+      VERSION = "3.0.0"
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-scheduler
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Google LLC
 bindir: bin
 cert_chain: []
-date: 2025-01-29 00:00:00.000000000 Z
+date: 2025-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -27,42 +27,16 @@ dependencies:
   name: google-cloud-scheduler-v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.10'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.a
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.10'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.a
-- !ruby/object:Gem::Dependency
-  name: google-cloud-scheduler-v1beta1
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.10'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.10'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.2'
 description: 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
@@ -77,7 +51,6 @@ files:
 - ".yardopts"
 - AUTHENTICATION.md
 - LICENSE.md
-- MIGRATING.md
 - README.md
 - lib/google-cloud-scheduler.rb
 - lib/google/cloud/scheduler.rb
@@ -100,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.3
 specification_version: 4
 summary: API Client library for the Cloud Scheduler API
 test_files: []

data/MIGRATING.md

@@ -1,321 +0,0 @@
-## Migrating to google-cloud-scheduler 2.0
-
-The 2.0 release of the google-cloud-scheduler client is a significant upgrade
-based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-ruby),
-and includes substantial interface changes. Existing code written for earlier
-versions of this library will likely require updates to use this version.
-This document describes the changes that have been made, and what you need to
-do to update your usage.
-
-To summarize:
-
- *  The library has been broken out into three libraries. The new gems
-    `google-cloud-scheduler-v1` and `google-cloud-scheduler-v1beta1` contain the
-    actual client classes for versions V1 and V1beta1 of the Cloud Scheduler
-    service, and the gem `google-cloud-scheduler` now simply provides a
-    convenience wrapper. See [Library Structure](#library-structure) for more
-    info.
- *  The library uses a new configuration mechanism giving you closer control
-    over endpoint address, network timeouts, and retry. See
-    [Client Configuration](#client-configuration) for more info. Furthermore,
-    when creating a client object, you can customize its configuration in a
-    block rather than passing arguments to the constructor. See
-    [Creating Clients](#creating-clients) for more info.
- *  Previously, positional arguments were used to indicate required arguments.
-    Now, all method arguments are keyword arguments, with documentation that
-    specifies whether they are required or optional. Additionally, you can pass
-    a proto request object instead of separate arguments. See
-    [Passing Arguments](#passing-arguments) for more info.
- *  Previously, some client classes included helper methods for constructing
-    resource paths. These methods now take keyword rather than positional
-    arguments, and are also available in a separate paths module. See
-    [Resource Path Helpers](#resource-path-helpers) for more info.
- *  Previously, clients reported RPC errors by raising instances of
-    `Google::Gax::GaxError` and its subclasses. Now, RPC exceptions are of type
-    `Google::Cloud::Error` and its subclasses. See
-    [Handling Errors](#handling-errors) for more info.
- *  Some classes have moved into different namespaces. See
-    [Class Namespaces](#class-namespaces) for more info.
-
-### Library Structure
-
-Older 1.x releases of the `google-cloud-scheduler` gem were all-in-one gems that
-included potentially multiple clients for multiple versions of the Cloud
-Scheduler service. The `Google::Cloud::Scheduler.new` factory method would
-return you an instance of a `Google::Cloud::Scheduler::V1::CloudSchedulerClient`
-object for the V1 version of the service, or a
-`Google::Cloud::Scheduler::V1beta1::CloudSchedulerClient` object for the
-V1beta1 version of the service. All these classes were defined in the same gem.
-
-With the 2.0 release, the `google-cloud-scheduler` gem still provides factory
-methods for obtaining clients. (The method signatures will have changed. See
-[Creating Clients](#creating-clients) for details.) However, the actual client
-classes have been moved into separate gems, one per service version. The
-`Google::Cloud::Scheduler::V1::CloudScheduler::Client` class, along with its
-helpers and data types, is now part of the `google-cloud-scheduler-v1` gem.
-Similarly, the `Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client`
-class is part of the `google-cloud-scheduler-v1beta1` gem. 
-
-For normal usage, you can continue to install the `google-cloud-scheduler` gem
-(which will bring in the versioned client gems as dependencies) and continue to
-use factory methods to create clients. However, you may alternatively choose to
-install only one of the versioned gems. For example, if you know you will use only
-`V1` of the service, you can install `google-cloud-scheduler-v1` by itself, and
-construct instances of the
-`Google::Cloud::Scheduler::V1::CloudScheduler::Client` client class directly.
-
-### Client Configuration
-
-In older releases, if you wanted to customize performance parameters or
-low-level behavior of the client (such as credentials, timeouts, or
-instrumentation), you would pass a variety of keyword arguments to the client
-constructor. It was also extremely difficult to customize the default settings.
-
-With the 2.0 release, a configuration interface provides control over these
-parameters, including defaults for all instances of a client, and settings for
-each specific client instance. For example, to set default credentials and
-timeout for all Cloud Scheduler V1 clients:
-
-```
-Google::Cloud::Scheduler::V1::CloudScheduler::Client.configure do |config|
-  config.credentials = "/path/to/credentials.json"
-  config.timeout = 10.0
-end
-```
-
-Individual RPCs can also be configured independently. For example, to set the
-timeout for the `list_jobs` call:
-
-```
-Google::Cloud::Scheduler::V1::CloudScheduler::Client.configure do |config|
-  config.rpcs.list_jobs.timeout = 20.0
-end
-```
-
-Defaults for certain configurations can be set for all Scheduler versions
-globally:
-
-```
-Google::Cloud::Scheduler.configure do |config|
-  config.credentials = "/path/to/credentials.json"
-  config.timeout = 10.0
-end
-```
-
-Finally, you can override the configuration for each client instance. See the
-next section on [Creating Clients](#creating-clients) for details.
-
-### Creating Clients
-
-In older releases, to create a client object, you would use the
-`Google::Cloud::Scheduler.new` class method. Keyword arguments were available to
-select a service version and to configure parameters such as credentials and
-timeouts.
-
-With the 2.0 release, use the `Google::Cloud::Scheduler.cloud_scheduler` class
-method to create a client object. You may select a service version using the
-`:version` keyword argument. However, other configuration parameters should be
-set in a configuration block when you create the client.
-
-Old:
-```
-client = Google::Cloud::Scheduler.new credentials: "/path/to/credentials.json"
-```
-
-New:
-```
-client = Google::Cloud::Scheduler.cloud_scheduler do |config|
-  config.credentials = "/path/to/credentials.json"
-end
-```
-
-The configuration block is optional. If you do not provide it, or you do not
-set some configuration parameters, then the default configuration is used. See
-[Client Configuration](#client-configuration).
-
-### Passing Arguments
-
-In older releases, required arguments would be passed as positional method
-arguments, while most optional arguments would be passed as keyword arguments.
-
-With the 2.0 release, all RPC arguments are passed as keyword arguments,
-regardless of whether they are required or optional. For example:
-
-Old:
-```
-client = Google::Cloud::Scheduler.new
-
-parent = "projects/my-project/locations/-"
-
-# Parent is a positional argument, while page_size is a keyword argument.
-response = client.list_jobs parent, page_size: 10
-```
-
-New:
-```
-client = Google::Cloud::Scheduler.cloud_scheduler
-
-parent = "projects/my-project/locations/-"
-
-# Both parent and page_size are keyword arguments.
-response = client.list_jobs parent: parent, page_size: 10
-```
-
-In the 2.0 release, it is also possible to pass a request object, either
-as a hash or as a protocol buffer.
-
-New:
-```
-client = Google::Cloud::Scheduler.cloud_scheduler
-
-request = Google::Cloud::Scheduler::V1::ListJobsRequest.new(
-  parent: "projects/my-project/locations/-",
-  page_size: 10
-)
-
-# Pass a request object as a positional argument:
-response = client.list_jobs request
-```
-
-Finally, in older releases, to provide call options, you would pass a
-`Google::Gax::CallOptions` object with the `:options` keyword argument. In the
-2.0 release, pass call options using a _second set_ of keyword arguments.
-
-Old:
-```
-client = Google::Cloud::Scheduler.new
-
-parent = "projects/my-project/locations/-"
-
-options = Google::Gax::CallOptions.new timeout: 10.0
-
-response = client.list_jobs parent, page_size: 10, options: options
-```
-
-New:
-```
-client = Google::Cloud::Scheduler.cloud_scheduler
-
-parent = "projects/my-project/locations/-"
-
-# Use a hash to wrap the normal call arguments (or pass a request object), and
-# then add further keyword arguments for the call options.
-response = client.list_jobs(
-  { parent: parent, page_size: 10 },
-  timeout: 10.0
-)
-```
-
-### Resource Path Helpers
-
-The client library includes helper methods for generating the resource path
-strings passed to many calls. These helpers have changed in two ways:
-
-* In older releases, they are both _class_ methods and _instance_ methods on
-  the client class. In the 2.0 release, they are _instance methods only_.
-  However, they are also available on a separate paths module that you can
-  include elsewhere for convenience.
-* In older releases, arguments to a resource path helper are passed as
-  _positional_ arguments. In the 2.0 release, they are passed as named _keyword_
-  arguments.
-
-Following is an example involving using a resource path helper.
-
-Old:
-```
-client = Google::Cloud::Scheduler.new
-
-# Call the helper using positional arguments.
-parent = client.location_path "my-project", "-"
-
-response = client.list_jobs parent
-```
-
-New:
-```
-client = Google::Cloud::Scheduler.cloud_scheduler
-
-# Call the helper using keyword arguments
-parent = client.location_path project: "my-project", location: "-"
-
-response = client.list_jobs parent: parent
-```
-
-In the 2.0 client, you can also use the paths module as a convenience module.
-
-New:
-```
-# Bring the path helper methods into the current class
-include Google::Cloud::Scheduler::V1::CloudScheduler::Paths
-
-def foo
-  client = Google::Cloud::Scheduler.cloud_scheduler
-
-  # Call the included helper method
-  parent = location_path project: "my-project", location: "-"
-
-  response = client.list_jobs parent: parent
-
-  # Do something with response...
-end
-```
-
-### Handling Errors
-
-The client reports standard
-[gRPC error codes](https://github.com/grpc/grpc/blob/master/doc/statuscodes.md)
-by raising exceptions. In older releases, these exceptions were located in the
-`Google::Gax` namespace and were subclasses of the `Google::Gax::GaxError` base
-exception class, defined in the `google-gax` gem. However, these classes were
-different from the standard exceptions (subclasses of `Google::Cloud::Error`)
-thrown by other client libraries such as `google-cloud-storage`.
-
-The 2.0 client library now uses the `Google::Cloud::Error` exception hierarchy,
-for consistency across all the Google Cloud client libraries. In general, these
-exceptions have the same name as their counterparts from older releases, but
-are located in the `Google::Cloud` namespace rather than the `Google::Gax`
-namespace.
-
-Old:
-```
-client = Google::Cloud::Scheduler.new
-
-parent = "projects/my-project/locations/-"
-
-begin
-  response = client.list_jobs parent, page_size: 10
-rescue Google::Gax::Error => e
-  # Handle exceptions that subclass Google::Gax::Error
-end
-```
-
-New:
-```
-client = Google::Cloud::Scheduler.cloud_scheduler
-
-parent = "projects/my-project/locations/-"
-
-begin
-  response = client.list_jobs parent: parent, page_size: 10
-rescue Google::Cloud::Error => e
-  # Handle exceptions that subclass Google::Cloud::Error
-end
-```
-
-### Class Namespaces
-
-In older releases, the client object was of class
-`Google::Cloud::Scheduler::V1::CloudSchedulerClient`.
-In the 2.0 release, the client object is of class
-`Google::Cloud::Scheduler::V1::CloudScheduler::Client`.
-Note that most users will use the `Google::Cloud::Scheduler.cloud_scheduler`
-factory method to create instances of the client object, so you may not need to
-reference the actual class directly.
-See [Creating Clients](#creating-clients).
-
-In older releases, the credentials object was of class
-`Google::Cloud::Scheduler::V1::Credentials`.
-In the 2.0 release, the credentials object is of class
-`Google::Cloud::Scheduler::V1::CloudScheduler::Credentials`.
-Again, most users will not need to reference this class directly.
-See [Client Configuration](#client-configuration).