lib/google/cloud/redis/v1/cloud_redis_client.rb in google-cloud-redis-0.2.2 vs lib/google/cloud/redis/v1/cloud_redis_client.rb in google-cloud-redis-0.2.3

- old
+ new

@@ -36,21 +36,21 @@ module V1 # 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` # # @!attribute [r] cloud_redis_stub # @return [Google::Cloud::Redis::V1::CloudRedis::Stub] class CloudRedisClient # @private @@ -267,19 +267,19 @@ # Lists all Redis instances owned by a project in either the specified # location (region) or all locations. # # The location should have the following format: - # * +projects/\\{project_id}/locations/\\{location_id}+ + # * `projects/{project_id}/locations/{location_id}` # - # If +location_id+ is specified as +-+ (wildcard), then all regions + # If `location_id` is specified as `-` (wildcard), then all regions # available to the project are queried, and the results are aggregated. # # @param parent [String] # Required. The resource name of the instance location using the form: - # +projects/\\{project_id}/locations/\\{location_id}+ - # where +location_id+ refers to a GCP region + # `projects/{project_id}/locations/{location_id}` + # where `location_id` refers to a GCP region # @param page_size [Integer] # The maximum number of resources contained in the underlying API # response. If page streaming is performed per-resource, this # parameter does not affect the return value. If page streaming is # performed per-page, this determines the maximum number of @@ -330,12 +330,12 @@ # Gets the details of a specific Redis instance. # # @param name [String] # Required. Redis instance resource name using the form: - # +projects/\\{project_id}/locations/\\{location_id}/instances/\\{instance_id}+ - # where +location_id+ refers to a GCP region + # `projects/{project_id}/locations/{location_id}/instances/{instance_id}` + # where `location_id` refers to a GCP region # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @yield [result, operation] Access the result along with the RPC operation # @yieldparam result [Google::Cloud::Redis::V1::Instance] @@ -373,12 +373,12 @@ # The returned operation is automatically deleted after a few hours, so there # is no need to call DeleteOperation. # # @param parent [String] # Required. The resource name of the instance location using the form: - # +projects/\\{project_id}/locations/\\{location_id}+ - # where +location_id+ refers to a GCP region + # `projects/{project_id}/locations/{location_id}` + # where `location_id` refers to a GCP region # @param instance_id [String] # Required. The logical name of the Redis instance in the customer project # with the following restrictions: # # * Must contain only lowercase letters, numbers, and hyphens. @@ -463,14 +463,14 @@ # @param update_mask [Google::Protobuf::FieldMask | Hash] # Required. Mask of fields to update. At least one path must be supplied in # this field. The elements of the repeated paths field may only include these # fields from {CloudRedis::Instance Instance}: # - # * +displayName+ - # * +labels+ - # * +memorySizeGb+ - # * +redisConfig+ + # * `displayName` + # * `labels` + # * `memorySizeGb` + # * `redisConfig` # A hash of the same form as `Google::Protobuf::FieldMask` # can also be provided. # @param instance [Google::Cloud::Redis::V1::Instance | Hash] # Required. Update description. # Only fields specified in update_mask are updated. @@ -543,11 +543,11 @@ # Deletes a specific Redis instance. Instance stops serving and data is # deleted. # # @param name [String] # Required. Redis instance resource name using the form: - # +projects/\\{project_id}/locations/\\{location_id}/instances/\\{instance_id}+ - # where +location_id+ refers to a GCP region + # `projects/{project_id}/locations/{location_id}/instances/{instance_id}` + # where `location_id` refers to a GCP region # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @return [Google::Gax::Operation] # @raise [Google::Gax::GaxError] if the RPC is aborted.