lib/google/cloud/redis/v1.rb in google-cloud-redis-0.2.2 vs lib/google/cloud/redis/v1.rb in google-cloud-redis-0.2.3
- old
+ new
@@ -20,11 +20,11 @@
module Cloud
module Redis
# rubocop:disable LineLength
##
- # # Ruby Client for Google Cloud Memorystore for Redis API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
+ # # Ruby Client for Google Cloud Memorystore for Redis API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
#
# [Google Cloud Memorystore for Redis API][Product Documentation]:
# The Google Cloud Memorystore for Redis API is used for creating and managing
# Redis instances on the Google Cloud Platform.
# - [Product Documentation][]
@@ -34,30 +34,30 @@
# steps:
#
# 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
# 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
# 3. [Enable the Google Cloud Memorystore for Redis API.](https://console.cloud.google.com/apis/library/redis.googleapis.com)
- # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+ # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
#
# ### Installation
# ```
# $ gem install google-cloud-redis
# ```
#
# ### Next Steps
# - Read the [Google Cloud Memorystore for Redis API Product documentation][Product Documentation]
# to learn more about the product and see How-to Guides.
- # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
+ # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
# to see the full list of Cloud APIs that we cover.
#
# [Product Documentation]: https://cloud.google.com/memorystore
#
# ## 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-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
- # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
+ # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
# that will write logs to [Stackdriver 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:
#
@@ -83,20 +83,20 @@
##
# Configures and manages Cloud Memorystore for Redis instances
#
# Google Cloud Memorystore for Redis v1
#
- # The +redis.googleapis.com+ service implements the Google Cloud Memorystore
+ # The `redis.googleapis.com` service implements the Google Cloud Memorystore
# for Redis API and defines the following resource model for managing Redis
# instances:
- # * The service works with a collection of cloud projects, named: +/projects/*+
- # * Each project has a collection of available locations, named: +/locations/*+
- # * Each location has a collection of Redis instances, named: +/instances/*+
+ # * The service works with a collection of cloud projects, named: `/projects/*`
+ # * Each project has a collection of available locations, named: `/locations/*`
+ # * Each location has a collection of Redis instances, named: `/instances/*`
# * As such, Redis instances are resources of the form:
- # +/projects/\\{project_id}/locations/\\{location_id}/instances/\\{instance_id}+
+ # `/projects/{project_id}/locations/{location_id}/instances/{instance_id}`
#
- # Note that location_id must be refering to a GCP +region+; for example:
- # * +projects/redpepper-1290/locations/us-central1/instances/my-redis+
+ # Note that location_id must be refering to a GCP `region`; for example:
+ # * `projects/redpepper-1290/locations/us-central1/instances/my-redis`
#
# @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
# Provides the means for authenticating requests made by the client. This parameter can
# be many types.
# A `Google::Auth::Credentials` uses a the properties of its represented keyfile for