google-cloud-backupdr-v1 0.a → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b84e43bb64e1d0af0d3e0f4aff6caa18279a0f2a2a43fa8386d77c20cf9d0b77
-  data.tar.gz: 283909721894d55630e8d223c4bd2d0285bd4fa190bb86871e16a9042a872e0c
+  metadata.gz: b715518301177339827269f412a6b313a603eeb9245c10cd62b0a2be6ccd1bfa
+  data.tar.gz: 744ffc0003d452a0a58e23bd909422fe83cd1a444d5ae307251ed7730294fca3
 SHA512:
-  metadata.gz: 3cfba1aac49d6e37a16ac04b4046880addbda74f2d2680ac0e55f6c0005781d7ad24dc40c273b58aa103e464cb512fcdee415070ca2ae2a7c98917e1076c33ab
-  data.tar.gz: 14eb6ada427b0602df5b40066cc404434c2f0ee1d7ccb968936bc32190f4293dd3144ea7db78dd832ff03a3a97604d5f6aaa86409fa065ca05acb3f4ec3716c0
+  metadata.gz: 9e4d510e94d2c48c8dc335312ade219304777756b8f11a390840022266528610f6de9678010603786242f03badf495c3c0e02dca13fcd04b2997757711e369e1
+  data.tar.gz: 24ddeebd651a1b4e95ff587d4e240aa58966a3be376f63aad5dfad1b0a3d1d8ffcf4ec77f64d258e2001b9668703e35b3cefa87caf39affe38ee1e1fd769be3c

data/.yardopts

@@ -0,0 +1,12 @@
+--no-private
+--title="Backup and DR Service V1 API"
+--exclude _pb\.rb$
+--markup markdown
+--markup-provider redcarpet
+
+./lib/**/*.rb
+./proto_docs/**/*.rb
+-
+README.md
+LICENSE.md
+AUTHENTICATION.md

data/AUTHENTICATION.md

@@ -0,0 +1,122 @@
+# Authentication
+
+The recommended way to authenticate to the google-cloud-backupdr-v1 library is to use
+[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
+To review all of your authentication options, see [Credentials lookup](#credential-lookup).
+
+## Quickstart
+
+The following example shows how to set up authentication for a local development
+environment with your user credentials. 
+
+**NOTE:** This method is _not_ recommended for running in production. User credentials
+should be used only during development.
+
+1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
+2. Set up a local ADC file with your user credentials:
+
+```sh
+gcloud auth application-default login
+```
+
+3. Write code as if already authenticated.
+
+For more information about setting up authentication for a local development environment, see
+[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
+
+## Credential Lookup
+
+The google-cloud-backupdr-v1 library provides several mechanisms to configure your system.
+Generally, using Application Default Credentials to facilitate automatic 
+credentials discovery is the easist method. But if you need to explicitly specify
+credentials, there are several methods available to you.
+
+Credentials are accepted in the following ways, in the following order or precedence:
+
+1. Credentials specified in method arguments
+2. Credentials specified in configuration
+3. Credentials pointed to or included in environment variables
+4. Credentials found in local ADC file
+5. Credentials returned by the metadata server for the attached service account (GCP)
+
+### Configuration
+
+You can configure a path to a JSON credentials file, either for an individual client object or
+globally, for all client objects. The JSON file can contain credentials created for
+[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
+[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
+[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
+
+Note: Service account keys are a security risk if not managed correctly. You should
+[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
+whenever possible.
+
+To configure a credentials file for an individual client initialization:
+
+```ruby
+require "google/cloud/backupdr/v1"
+
+client = ::Google::Cloud::BackupDR::V1::BackupDR::Client.new do |config|
+  config.credentials = "path/to/credentialfile.json"
+end
+```
+
+To configure a credentials file globally for all clients:
+
+```ruby
+require "google/cloud/backupdr/v1"
+
+::Google::Cloud::BackupDR::V1::BackupDR::Client.configure do |config|
+  config.credentials = "path/to/credentialfile.json"
+end
+
+client = ::Google::Cloud::BackupDR::V1::BackupDR::Client.new
+```
+
+### Environment Variables
+
+You can also use an environment variable to provide a JSON credentials file.
+The environment variable can contain a path to the credentials file or, for
+environments such as Docker containers where writing files is not encouraged,
+you can include the credentials file itself.
+
+The JSON file can contain credentials created for
+[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
+[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
+[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
+
+Note: Service account keys are a security risk if not managed correctly. You should
+[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
+whenever possible.
+
+The environment variables that google-cloud-backupdr-v1
+checks for credentials are:
+
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+
+```ruby
+require "google/cloud/backupdr/v1"
+
+ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
+
+client = ::Google::Cloud::BackupDR::V1::BackupDR::Client.new
+```
+
+### Local ADC file
+
+You can set up a local ADC file with your user credentials for authentication during
+development. If credentials are not provided in code or in environment variables,
+then the local ADC credentials are discovered.
+
+Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
+
+### Google Cloud Platform environments
+
+When running on Google Cloud Platform (GCP), including Google Compute Engine
+(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
+Functions (GCF) and Cloud Run, credentials are retrieved from the attached
+service account automatically. Code should be written as if already authenticated.
+
+For more information, see
+[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).

data/README.md

@@ -1,8 +1,144 @@
-# Placeholder for Ruby gem google-cloud-backupdr-v1
-
-This is a placeholder for the future Google-authored gem google-cloud-backupdr-v1.
-This placeholder is being released on 2024-04-18 in order to reserve the name.
-The final gem should be available shortly after that date. If it has not been
-released in a timely manner, or if this placeholder interferes with your work,
-you can contact the Google Ruby team by opening an issue in the GitHub
-repository https://github.com/googleapis/google-cloud-ruby.
+# Ruby Client for the Backup and DR Service V1 API
+
+API Client library for the Backup and DR Service V1 API
+
+google-cloud-backupdr-v1 is the official client library for the Backup and DR Service V1 API.
+
+https://github.com/googleapis/google-cloud-ruby
+
+This gem is a _versioned_ client. It provides basic client classes for a
+specific version of the Backup and DR Service V1 API. Most users should consider using
+the main client gem,
+[google-cloud-backupdr](https://rubygems.org/gems/google-cloud-backupdr).
+See the section below titled *Which client should I use?* for more information.
+
+## Installation
+
+```
+$ gem install google-cloud-backupdr-v1
+```
+
+## Before You Begin
+
+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/backupdr.googleapis.com)
+1. {file:AUTHENTICATION.md Set up authentication.}
+
+## Quick Start
+
+```ruby
+require "google/cloud/backupdr/v1"
+
+client = ::Google::Cloud::BackupDR::V1::BackupDR::Client.new
+request = ::Google::Cloud::BackupDR::V1::ListManagementServersRequest.new # (request fields as keyword arguments...)
+response = client.list_management_servers request
+```
+
+View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-backupdr-v1/latest)
+for class and method documentation.
+
+See also the [Product Documentation](https://cloud.google.com/backup-disaster-recovery/docs/reference/rpc)
+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/current/stdlibs/logger/Logger.html) as shown below,
+or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/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.
+
+Configuring a Ruby stdlib logger:
+
+```ruby
+require "logger"
+
+module MyLogger
+  LOGGER = Logger.new $stderr, level: Logger::WARN
+  def logger
+    LOGGER
+  end
+end
+
+# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+module GRPC
+  extend MyLogger
+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.7+.
+
+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-backupdr`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-backupdr-v1`.
+_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-backupdr`.
+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-backupdr-v1`.
+
+### 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.