Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions google-cloud-compute-v1/.OwlBot.yaml

This file was deleted.

887 changes: 0 additions & 887 deletions google-cloud-compute-v1/.owlbot-manifest.json

This file was deleted.

37 changes: 0 additions & 37 deletions google-cloud-compute-v1/.owlbot.rb

This file was deleted.

2 changes: 1 addition & 1 deletion google-cloud-compute-v1/.yardopts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
--no-private
--title="Google Cloud Compute V1 API"
--title="Compute Engine V1 API"
--exclude _pb\.rb$
--markup markdown
--markup-provider redcarpet
Expand Down
69 changes: 66 additions & 3 deletions google-cloud-compute-v1/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
# Ruby Client for the Google Cloud Compute V1 API
# Ruby Client for the Compute Engine V1 API

API Client library for the Google Cloud Compute V1 API
Compute Engine is an infrastructure as a service (IaaS) product that offers self-managed virtual machine (VM) instances and bare metal instances.

google-cloud-compute-v1 is the official client library for the Google Cloud Compute 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 Compute Engine V1 API. Most users should consider using
the main client gem,
[google-cloud-compute](https://rubygems.org/gems/google-cloud-compute).
See the section below titled *Which client should I use?* for more information.

## Installation

```
Expand Down Expand Up @@ -88,3 +93,61 @@ 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-compute`,
and lower-level _versioned_ client libraries with names such as
`google-cloud-compute-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-compute`.
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-compute-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.
4 changes: 2 additions & 2 deletions google-cloud-compute-v1/google-cloud-compute-v1.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Gem::Specification.new do |gem|

gem.authors = ["Google LLC"]
gem.email = "googleapis-packages@google.com"
gem.description = "google-cloud-compute-v1 is the official client library for the Google Cloud Compute V1 API."
gem.summary = "API Client library for the Google Cloud Compute V1 API"
gem.description = "Compute Engine is an infrastructure as a service (IaaS) product that offers self-managed virtual machine (VM) instances and bare metal instances. Note that google-cloud-compute-v1 is a version-specific client library. For most uses, we recommend installing the main client library google-cloud-compute instead. See the readme for more details."
gem.summary = "Compute Engine is an infrastructure as a service (IaaS) product that offers self-managed virtual machine (VM) instances and bare metal instances."
gem.homepage = "https://github.com/googleapis/google-cloud-ruby"
gem.license = "Apache-2.0"

Expand Down

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion google-cloud-compute-v1/proto_docs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Google Cloud Compute V1 Protocol Buffer Documentation
# Compute Engine V1 Protocol Buffer Documentation

These files are for the YARD documentation of the generated protobuf files.
They are not intended to be required or loaded at runtime.
Loading
Loading