google-cloud-resource_manager 0.39.0 → 1.0.0

data/MIGRATING.md

@@ -0,0 +1,194 @@
+## Migrating to google-cloud-resource_manager 1.0
+
+The 1.0 release of the google-cloud-resource_manager client is a significant
+upgrade to add a number of new features in version V3 of the resource manager
+service, and to bring the client interfaces and technology up to date with the
+rest of Google's modern API clients. As part of this processs, substantial
+interface changes were made, so 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 client has been rewritten to use the new high-performance gRPC endpoint
+    for the new version V3 of the service. (Earlier client versions used the
+    HTTP/REST endpoint for version V1 of the service.)
+ *  The library has been broken out into two libraries. The new gem
+    `google-cloud-resource_manager-v3` contains the actual client classes for
+    version V3 of the Resource Manager service, and  the gem
+    `google-cloud-resource_manager` 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.
+ *  Nearly all classes have been redesigned and have different names. See
+    [Class Design](#class-design) for more info.
+
+### Library Structure
+
+Older 0.x releases of the `google-cloud-resource_manager` gem provided the
+entire client interface in one gem. This included major data types, and client
+objects with methods for the various calls. These classes were in turn powered
+by the `google-apis-cloudresourcemanager_v1` gem which handled lower-level REST
+calls.
+
+With the 1.0 release, the `google-cloud-resource_manager` gem itself provides
+factory methods for obtaining client objects, but the client classes and data
+types themselves are defined in a separate gem
+`google-cloud-resource_manager-v3`. Normally, your app can continue to install
+`google-cloud-resource_manager`, which will bring in the lower-level
+`google-cloud-resource_manager-v3` gem as a dependency. It is also possible for
+to install only `google-cloud-resource_manager-v3` if you know you will use
+only V3 of the service.
+
+### 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 1.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 Resource Manager V3 projects clients:
+
+```
+Google::Cloud::ResourceManager::V3::Projects::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_projects` call:
+
+```
+Google::Cloud::ResourceManager::V3::Projects::Client.configure do |config|
+  config.rpcs.list_projects.timeout = 20.0
+end
+```
+
+Defaults for certain configurations can be set for all ResourceManager versions
+globally:
+
+```
+Google::Cloud::ResourceManager.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::ResourceManager.new` class method. Keyword arguments were
+available to configure parameters such as credentials and timeouts.
+
+With the 1.0 release, use named class methods of
+`Google::Cloud::ResourceManager` to create a client object. For example, use
+`Google::Cloud::ResourceManager.projects` to create a client for
+projects-related RPCs. 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::ResourceManager.new credentials: "/path/to/credentials.json"
+```
+
+New:
+```
+client = Google::Cloud::ResourceManager.projects 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 1.0 release, all RPC arguments are passed as keyword arguments,
+regardless of whether they are required or optional. Additionally, the
+structure of some arguments may have changed: many arguments that were
+previously "flattened" are now provided in the form of data structures, usually
+the same data structures returned as responses. For example:
+
+Old:
+```
+client = Google::Cloud::ResourceManager.new
+
+# The project ID is a positional argument by itself, and optional arguments
+# are separate keyword arguments.
+response = client.create_project "my-project", name: "My great project"
+```
+
+New:
+```
+client = Google::Cloud::ResourceManager.projects
+
+# Create a project data structure and pass it as a keyword argument.
+project = {
+  project_id: "my-project",
+  name: "My great project"
+}
+
+response = client.create_project project: project
+```
+
+Additionally, in older releases, it was often difficult or impossible to
+provide per-call options such as timeouts. In the 1.0 release, you can now
+pass call options using a _second set_ of keyword arguments.
+
+New:
+```
+client = Google::Cloud::ResourceManager.projects
+
+project = {
+  project_id: "my-project",
+  name: "My great project"
+}
+
+# Use a hash to wrap the normal call arguments, and
+# then add further keyword arguments for the call options.
+response = client.create_project({ project: project }, timeout: 10.0)
+```
+
+### Class Design
+
+In older releases, the main client object was of type
+`Google::Cloud::ResourceManager::Project`, and included methods covering all
+functionality for version V1 of the Resource Manager. In the 1.0 release,
+several different client objects are provided, covering the various parts of
+the expanded Resource Manager V3 functionality. These client classes include
+`Google::Cloud::ResourceManager::V3::Projects::Client`,
+`Google::Cloud::ResourceManager::V3::Projects::Organizations`,
+`Google::Cloud::ResourceManager::V3::Projects::Folders`, and others. You can
+construct instances of these classes using the provided class methods on the
+`Google::Cloud::ResourceManager` module.
+
+In older releases, certain data types were represented by Ruby classes under
+the `Google::Cloud::ResourceManager` namespace, including
+`Google::Cloud::ResourceMnaager::Policy` and
+`Google::Cloud::ResourceManager::Resource`. The functionality in these data
+types was extremely limited. In the 1.0 release, you will use protocol buffer
+message types for all resources, such as
+`Google::Cloud::ResourceManager::V3::Project` and
+`Google::Cloud::ResourceManager::V3::Organization`.

data/README.md

@@ -0,0 +1,131 @@
+# Ruby Client for the Cloud Resource Manager API
+
+Creates, reads, and updates metadata for Google Cloud Platform resource containers.
+
+Creates, reads, and updates metadata for Google Cloud Platform resource containers.
+
+Actual client classes for the various versions of this API are defined in
+_versioned_ client gems, with names of the form `google-cloud-resource_manager-v*`.
+The gem `google-cloud-resource_manager` is the main client library that brings the
+verisoned gems in as dependencies, and provides high-level methods for
+constructing clients. More information on versioned clients can be found below
+in the section titled *Which client should I use?*.
+
+View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-resource_manager/latest)
+for this library, google-cloud-resource_manager, 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-resource_manager-v3](https://cloud.google.com/ruby/docs/reference/google-cloud-resource_manager-v3/latest).
+
+## Quick Start
+
+```
+$ gem install google-cloud-resource_manager
+```
+
+In order to use this library, you first need to go through the following steps:
+
+1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+1. [Enable the API.](https://console.cloud.google.com/apis/library/cloudresourcemanager.googleapis.com)
+1. {file:AUTHENTICATION.md Set up authentication.}
+
+## Debug Logging
+
+This library comes with opt-in Debug Logging that can help you troubleshoot
+your application's integration with the API. When logging is activated, key
+events such as requests and responses, along with data payloads and metadata
+such as headers and client configuration, are logged to the standard error
+stream.
+
+**WARNING:** Client Library Debug Logging includes your data payloads in
+plaintext, which could include sensitive data such as PII for yourself or your
+customers, private keys, or other security data that could be compromising if
+leaked. Always practice good data hygiene with your application logs, and follow
+the principle of least access. Google also recommends that Client Library Debug
+Logging be enabled only temporarily during active debugging, and not used
+permanently in production.
+
+To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
+to the value `all`. Alternatively, you can set the value to a comma-delimited
+list of client library gem names. This will select the default logging behavior,
+which writes logs to the standard error stream. On a local workstation, this may
+result in logs appearing on the console. When running on a Google Cloud hosting
+service such as [Google Cloud Run](https://cloud.google.com/run), this generally
+results in logs appearing alongside your application logs in the
+[Google Cloud Logging](https://cloud.google.com/logging/) service.
+
+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-resource_manager-v3](https://cloud.google.com/ruby/docs/reference/google-cloud-resource_manager-v3/latest).
+
+## Supported Ruby Versions
+
+This library is supported on Ruby 3.0+.
+
+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. 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?
+
+Most modern Ruby client libraries for Google APIs come in two flavors: the main
+client library with a name such as `google-cloud-resource_manager`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-resource_manager-v3`.
+_In most cases, you should install the main client._
+
+### What's the difference between the main client and a versioned client?
+
+A _versioned client_ provides a basic set of data types and client classes for
+a _single version_ of a specific service. (That is, for a service with multiple
+versions, there might be a separate versioned client for each service version.)
+Most versioned clients are written and maintained by a code generator.
+
+The _main client_ is designed to provide you with the _recommended_ client
+interfaces for the service. There will be only one main client for any given
+service, even a service with multiple versions. The main client includes
+factory methods for constructing the client objects we recommend for most
+users. In some cases, those will be classes provided by an underlying versioned
+client; in other cases, they will be handwritten higher-level client objects
+with additional capabilities, convenience methods, or best practices built in.
+Generally, the main client will default to a recommended service version,
+although in some cases you can override this if you need to talk to a specific
+service version.
+
+### Why would I want to use the main client?
+
+We recommend that most users install the main client gem for a service. You can
+identify this gem as the one _without_ a version in its name, e.g.
+`google-cloud-resource_manager`.
+The main client is recommended because it will embody the best practices for
+accessing the service, and may also provide more convenient interfaces or
+tighter integration into frameworks and third-party libraries. In addition, the
+documentation and samples published by Google will generally demonstrate use of
+the main client.
+
+### Why would I want to use a versioned client?
+
+You can use a versioned client if you are content with a possibly lower-level
+class interface, you explicitly want to avoid features provided by the main
+client, or you want to access a specific service version not be covered by the
+main client. You can identify versioned client gems because the service version
+is part of the name, e.g. `google-cloud-resource_manager-v3`.
+
+### What about the google-apis-<name> clients?
+
+Client library gems with names that begin with `google-apis-` are based on an
+older code generation technology. They talk to a REST/JSON backend (whereas
+most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
+not offer the same performance, features, and ease of use provided by more
+modern clients.
+
+The `google-apis-` clients have wide coverage across Google services, so you
+might need to use one if there is no modern client available for the service.
+However, if a modern client is available, we generally recommend it over the
+older `google-apis-` clients.

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

@@ -1,4 +1,6 @@
-# Copyright 2016 Google LLC
+# frozen_string_literal: true
+
+# Copyright 2025 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,11 +14,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
 
 module Google
   module Cloud
     module ResourceManager
-      VERSION = "0.39.0".freeze
+      VERSION = "1.0.0"
     end
   end
 end