google-cloud-redis 0.2.2 → 0.2.3

Sign up to get free protection for your applications and to get access to all the features.
@@ -15,14 +15,14 @@
15
15
 
16
16
  module Google
17
17
  module Protobuf
18
- # +FieldMask+ represents a set of symbolic field paths, for example:
18
+ # `FieldMask` represents a set of symbolic field paths, for example:
19
19
  #
20
20
  # paths: "f.a"
21
21
  # paths: "f.b.d"
22
22
  #
23
- # Here +f+ represents a field in some root message, +a+ and +b+
24
- # fields in the message found in +f+, and +d+ a field found in the
25
- # message in +f.b+.
23
+ # Here `f` represents a field in some root message, `a` and `b`
24
+ # fields in the message found in `f`, and `d` a field found in the
25
+ # message in `f.b`.
26
26
  #
27
27
  # Field masks are used to specify a subset of fields that should be
28
28
  # returned by a get operation or modified by an update operation.
@@ -85,7 +85,7 @@ module Google
85
85
  #
86
86
  # If a repeated field is specified for an update operation, the existing
87
87
  # repeated values in the target resource will be overwritten by the new values.
88
- # Note that a repeated field is only allowed in the last position of a +paths+
88
+ # Note that a repeated field is only allowed in the last position of a `paths`
89
89
  # string.
90
90
  #
91
91
  # If a sub-message is specified in the last position of the field mask for an
@@ -177,7 +177,7 @@ module Google
177
177
  # string address = 2;
178
178
  # }
179
179
  #
180
- # In proto a field mask for +Profile+ may look as such:
180
+ # In proto a field mask for `Profile` may look as such:
181
181
  #
182
182
  # mask {
183
183
  # paths: "user.display_name"
@@ -221,7 +221,7 @@ module Google
221
221
  #
222
222
  # The implementation of any API method which has a FieldMask type field in the
223
223
  # request should verify the included field paths, and return an
224
- # +INVALID_ARGUMENT+ error if any path is duplicated or unmappable.
224
+ # `INVALID_ARGUMENT` error if any path is duplicated or unmappable.
225
225
  # @!attribute [rw] paths
226
226
  # @return [Array<String>]
227
227
  # The set of field mask paths.
@@ -29,13 +29,13 @@ module Google
29
29
  #
30
30
  # = Examples
31
31
  #
32
- # Example 1: Compute Timestamp from POSIX +time()+.
32
+ # Example 1: Compute Timestamp from POSIX `time()`.
33
33
  #
34
34
  # Timestamp timestamp;
35
35
  # timestamp.set_seconds(time(NULL));
36
36
  # timestamp.set_nanos(0);
37
37
  #
38
- # Example 2: Compute Timestamp from POSIX +gettimeofday()+.
38
+ # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
39
39
  #
40
40
  # struct timeval tv;
41
41
  # gettimeofday(&tv, NULL);
@@ -44,7 +44,7 @@ module Google
44
44
  # timestamp.set_seconds(tv.tv_sec);
45
45
  # timestamp.set_nanos(tv.tv_usec * 1000);
46
46
  #
47
- # Example 3: Compute Timestamp from Win32 +GetSystemTimeAsFileTime()+.
47
+ # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
48
48
  #
49
49
  # FILETIME ft;
50
50
  # GetSystemTimeAsFileTime(&ft);
@@ -56,7 +56,7 @@ module Google
56
56
  # timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
57
57
  # timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
58
58
  #
59
- # Example 4: Compute Timestamp from Java +System.currentTimeMillis()+.
59
+ # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
60
60
  #
61
61
  # long millis = System.currentTimeMillis();
62
62
  #
@@ -87,10 +87,10 @@ module Google
87
87
  #
88
88
  # In JavaScript, one can convert a Date object to this format using the
89
89
  # standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString]
90
- # method. In Python, a standard +datetime.datetime+ object can be converted
91
- # to this format using [+strftime+](https://docs.python.org/2/library/time.html#time.strftime)
90
+ # method. In Python, a standard `datetime.datetime` object can be converted
91
+ # to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime)
92
92
  # with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one
93
- # can use the Joda Time's [+ISODateTimeFormat.dateTime()+](
93
+ # can use the Joda Time's [`ISODateTimeFormat.dateTime()`](
94
94
  # http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime--
95
95
  # ) to obtain a formatter capable of generating timestamps in this format.
96
96
  # @!attribute [rw] seconds
@@ -15,7 +15,7 @@
15
15
 
16
16
  module Google
17
17
  module Rpc
18
- # The +Status+ type defines a logical error model that is suitable for different
18
+ # The `Status` type defines a logical error model that is suitable for different
19
19
  # programming environments, including REST APIs and RPC APIs. It is used by
20
20
  # [gRPC](https://github.com/grpc). The error model is designed to be:
21
21
  #
@@ -24,7 +24,7 @@ module Google
24
24
  #
25
25
  # = Overview
26
26
  #
27
- # The +Status+ message contains three pieces of data: error code, error message,
27
+ # The `Status` message contains three pieces of data: error code, error message,
28
28
  # and error details. The error code should be an enum value of
29
29
  # {Google::Rpc::Code}, but it may accept additional error codes if needed. The
30
30
  # error message should be a developer-facing English message that helps
@@ -32,40 +32,40 @@ module Google
32
32
  # error message is needed, put the localized message in the error details or
33
33
  # localize it in the client. The optional error details may contain arbitrary
34
34
  # information about the error. There is a predefined set of error detail types
35
- # in the package +google.rpc+ that can be used for common error conditions.
35
+ # in the package `google.rpc` that can be used for common error conditions.
36
36
  #
37
37
  # = Language mapping
38
38
  #
39
- # The +Status+ message is the logical representation of the error model, but it
40
- # is not necessarily the actual wire format. When the +Status+ message is
39
+ # The `Status` message is the logical representation of the error model, but it
40
+ # is not necessarily the actual wire format. When the `Status` message is
41
41
  # exposed in different client libraries and different wire protocols, it can be
42
42
  # mapped differently. For example, it will likely be mapped to some exceptions
43
43
  # in Java, but more likely mapped to some error codes in C.
44
44
  #
45
45
  # = Other uses
46
46
  #
47
- # The error model and the +Status+ message can be used in a variety of
47
+ # The error model and the `Status` message can be used in a variety of
48
48
  # environments, either with or without APIs, to provide a
49
49
  # consistent developer experience across different environments.
50
50
  #
51
51
  # Example uses of this error model include:
52
52
  #
53
53
  # * Partial errors. If a service needs to return partial errors to the client,
54
- # it may embed the +Status+ in the normal response to indicate the partial
54
+ # it may embed the `Status` in the normal response to indicate the partial
55
55
  # errors.
56
56
  #
57
57
  # * Workflow errors. A typical workflow has multiple steps. Each step may
58
- # have a +Status+ message for error reporting.
58
+ # have a `Status` message for error reporting.
59
59
  #
60
60
  # * Batch operations. If a client uses batch request and batch response, the
61
- # +Status+ message should be used directly inside batch response, one for
61
+ # `Status` message should be used directly inside batch response, one for
62
62
  # each error sub-response.
63
63
  #
64
64
  # * Asynchronous operations. If an API call embeds asynchronous operation
65
65
  # results in its response, the status of those operations should be
66
- # represented directly using the +Status+ message.
66
+ # represented directly using the `Status` message.
67
67
  #
68
- # * Logging. If some API errors are stored in logs, the message +Status+ could
68
+ # * Logging. If some API errors are stored in logs, the message `Status` could
69
69
  # be used directly after any stripping needed for security/privacy reasons.
70
70
  # @!attribute [rw] code
71
71
  # @return [Integer]
@@ -22,7 +22,7 @@ module Google
22
22
  # rubocop:disable LineLength
23
23
 
24
24
  ##
25
- # # Ruby Client for Google Cloud Memorystore for Redis API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
25
+ # # Ruby Client for Google Cloud Memorystore for Redis API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
26
26
  #
27
27
  # [Google Cloud Memorystore for Redis API][Product Documentation]:
28
28
  # The Google Cloud Memorystore for Redis API is used for creating and managing
@@ -36,7 +36,7 @@ module Google
36
36
  # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
37
37
  # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
38
38
  # 3. [Enable the Google Cloud Memorystore for Redis API.](https://console.cloud.google.com/apis/library/redis.googleapis.com)
39
- # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
39
+ # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
40
40
  #
41
41
  # ### Installation
42
42
  # ```
@@ -46,7 +46,7 @@ module Google
46
46
  # ### Next Steps
47
47
  # - Read the [Google Cloud Memorystore for Redis API Product documentation][Product Documentation]
48
48
  # to learn more about the product and see How-to Guides.
49
- # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
49
+ # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
50
50
  # to see the full list of Cloud APIs that we cover.
51
51
  #
52
52
  # [Product Documentation]: https://cloud.google.com/memorystore
@@ -55,7 +55,7 @@ module Google
55
55
  #
56
56
  # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
57
57
  # 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,
58
- # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
58
+ # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
59
59
  # 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)
60
60
  # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
61
61
  #
@@ -85,17 +85,17 @@ module Google
85
85
  #
86
86
  # Google Cloud Memorystore for Redis v1beta1
87
87
  #
88
- # The +redis.googleapis.com+ service implements the Google Cloud Memorystore
88
+ # The `redis.googleapis.com` service implements the Google Cloud Memorystore
89
89
  # for Redis API and defines the following resource model for managing Redis
90
90
  # instances:
91
- # * The service works with a collection of cloud projects, named: +/projects/*+
92
- # * Each project has a collection of available locations, named: +/locations/*+
93
- # * Each location has a collection of Redis instances, named: +/instances/*+
91
+ # * The service works with a collection of cloud projects, named: `/projects/*`
92
+ # * Each project has a collection of available locations, named: `/locations/*`
93
+ # * Each location has a collection of Redis instances, named: `/instances/*`
94
94
  # * As such, Redis instances are resources of the form:
95
- # +/projects/\\{project_id}/locations/\\{location_id}/instances/\\{instance_id}+
95
+ # `/projects/{project_id}/locations/{location_id}/instances/{instance_id}`
96
96
  #
97
- # Note that location_id must be refering to a GCP +region+; for example:
98
- # * +projects/redpepper-1290/locations/us-central1/instances/my-redis+
97
+ # Note that location_id must be refering to a GCP `region`; for example:
98
+ # * `projects/redpepper-1290/locations/us-central1/instances/my-redis`
99
99
  #
100
100
  # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
101
101
  # Provides the means for authenticating requests made by the client. This parameter can
@@ -38,17 +38,17 @@ module Google
38
38
  #
39
39
  # Google Cloud Memorystore for Redis v1beta1
40
40
  #
41
- # The +redis.googleapis.com+ service implements the Google Cloud Memorystore
41
+ # The `redis.googleapis.com` service implements the Google Cloud Memorystore
42
42
  # for Redis API and defines the following resource model for managing Redis
43
43
  # instances:
44
- # * The service works with a collection of cloud projects, named: +/projects/*+
45
- # * Each project has a collection of available locations, named: +/locations/*+
46
- # * Each location has a collection of Redis instances, named: +/instances/*+
44
+ # * The service works with a collection of cloud projects, named: `/projects/*`
45
+ # * Each project has a collection of available locations, named: `/locations/*`
46
+ # * Each location has a collection of Redis instances, named: `/instances/*`
47
47
  # * As such, Redis instances are resources of the form:
48
- # +/projects/\\{project_id}/locations/\\{location_id}/instances/\\{instance_id}+
48
+ # `/projects/{project_id}/locations/{location_id}/instances/{instance_id}`
49
49
  #
50
- # Note that location_id must be refering to a GCP +region+; for example:
51
- # * +projects/redpepper-1290/locations/us-central1/instances/my-redis+
50
+ # Note that location_id must be refering to a GCP `region`; for example:
51
+ # * `projects/redpepper-1290/locations/us-central1/instances/my-redis`
52
52
  #
53
53
  # @!attribute [r] cloud_redis_stub
54
54
  # @return [Google::Cloud::Redis::V1beta1::CloudRedis::Stub]
@@ -269,15 +269,15 @@ module Google
269
269
  # location (region) or all locations.
270
270
  #
271
271
  # The location should have the following format:
272
- # * +projects/\\{project_id}/locations/\\{location_id}+
272
+ # * `projects/{project_id}/locations/{location_id}`
273
273
  #
274
- # If +location_id+ is specified as +-+ (wildcard), then all regions
274
+ # If `location_id` is specified as `-` (wildcard), then all regions
275
275
  # available to the project are queried, and the results are aggregated.
276
276
  #
277
277
  # @param parent [String]
278
278
  # Required. The resource name of the instance location using the form:
279
- # +projects/\\{project_id}/locations/\\{location_id}+
280
- # where +location_id+ refers to a GCP region
279
+ # `projects/{project_id}/locations/{location_id}`
280
+ # where `location_id` refers to a GCP region
281
281
  # @param page_size [Integer]
282
282
  # The maximum number of resources contained in the underlying API
283
283
  # response. If page streaming is performed per-resource, this
@@ -332,8 +332,8 @@ module Google
332
332
  #
333
333
  # @param name [String]
334
334
  # Required. Redis instance resource name using the form:
335
- # +projects/\\{project_id}/locations/\\{location_id}/instances/\\{instance_id}+
336
- # where +location_id+ refers to a GCP region
335
+ # `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
336
+ # where `location_id` refers to a GCP region
337
337
  # @param options [Google::Gax::CallOptions]
338
338
  # Overrides the default settings for this call, e.g, timeout,
339
339
  # retries, etc.
@@ -375,8 +375,8 @@ module Google
375
375
  #
376
376
  # @param parent [String]
377
377
  # Required. The resource name of the instance location using the form:
378
- # +projects/\\{project_id}/locations/\\{location_id}+
379
- # where +location_id+ refers to a GCP region
378
+ # `projects/{project_id}/locations/{location_id}`
379
+ # where `location_id` refers to a GCP region
380
380
  # @param instance_id [String]
381
381
  # Required. The logical name of the Redis instance in the customer project
382
382
  # with the following restrictions:
@@ -464,10 +464,10 @@ module Google
464
464
  # Required. Mask of fields to update. At least one path must be supplied in
465
465
  # this field. The elements of the repeated paths field may only include these
466
466
  # fields from {CloudRedis::Instance Instance}:
467
- # * +display_name+
468
- # * +labels+
469
- # * +memory_size_gb+
470
- # * +redis_config+
467
+ # * `display_name`
468
+ # * `labels`
469
+ # * `memory_size_gb`
470
+ # * `redis_config`
471
471
  # A hash of the same form as `Google::Protobuf::FieldMask`
472
472
  # can also be provided.
473
473
  # @param instance [Google::Cloud::Redis::V1beta1::Instance | Hash]
@@ -544,8 +544,8 @@ module Google
544
544
  #
545
545
  # @param name [String]
546
546
  # Required. Redis instance resource name using the form:
547
- # +projects/\\{project_id}/locations/\\{location_id}/instances/\\{instance_id}+
548
- # where +location_id+ refers to a GCP region
547
+ # `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
548
+ # where `location_id` refers to a GCP region
549
549
  # @param options [Google::Gax::CallOptions]
550
550
  # Overrides the default settings for this call, e.g, timeout,
551
551
  # retries, etc.
@@ -36,7 +36,7 @@ module Google
36
36
  # * Each project has a collection of available locations, named: `/locations/*`
37
37
  # * Each location has a collection of Redis instances, named: `/instances/*`
38
38
  # * As such, Redis instances are resources of the form:
39
- # `/projects/\\{project_id}/locations/\\{location_id}/instances/\\{instance_id}`
39
+ # `/projects/{project_id}/locations/{location_id}/instances/{instance_id}`
40
40
  #
41
41
  # Note that location_id must be refering to a GCP `region`; for example:
42
42
  # * `projects/redpepper-1290/locations/us-central1/instances/my-redis`
@@ -52,7 +52,7 @@ module Google
52
52
  # location (region) or all locations.
53
53
  #
54
54
  # The location should have the following format:
55
- # * `projects/\\{project_id}/locations/\\{location_id}`
55
+ # * `projects/{project_id}/locations/{location_id}`
56
56
  #
57
57
  # If `location_id` is specified as `-` (wildcard), then all regions
58
58
  # available to the project are queried, and the results are aggregated.
@@ -22,7 +22,7 @@ module Google
22
22
  # @return [String]
23
23
  # Required. Unique name of the resource in this scope including project and
24
24
  # location using the form:
25
- # +projects/\\{project_id}/locations/\\{location_id}/instances/\\{instance_id}+
25
+ # `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
26
26
  #
27
27
  # Note: Redis instances are managed and addressed at regional level so
28
28
  # location_id here refers to a GCP region; however, users get to choose which
@@ -98,7 +98,7 @@ module Google
98
98
  # @return [String]
99
99
  # Optional. The full name of the Google Compute Engine
100
100
  # [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the
101
- # instance is connected. If left unspecified, the +default+ network
101
+ # instance is connected. If left unspecified, the `default` network
102
102
  # will be used.
103
103
  class Instance
104
104
  # Represents the different states of a Redis instance.
@@ -121,7 +121,7 @@ module Google
121
121
  DELETING = 4
122
122
 
123
123
  # Redis instance is being repaired and may be unusable. Details can be
124
- # found in the +status_message+ field.
124
+ # found in the `status_message` field.
125
125
  REPAIRING = 5
126
126
 
127
127
  # Maintenance is being performed on this Redis instance.
@@ -145,8 +145,8 @@ module Google
145
145
  # @!attribute [rw] parent
146
146
  # @return [String]
147
147
  # Required. The resource name of the instance location using the form:
148
- # +projects/\\{project_id}/locations/\\{location_id}+
149
- # where +location_id+ refers to a GCP region
148
+ # `projects/{project_id}/locations/{location_id}`
149
+ # where `location_id` refers to a GCP region
150
150
  # @!attribute [rw] page_size
151
151
  # @return [Integer]
152
152
  # The maximum number of items to return.
@@ -168,7 +168,7 @@ module Google
168
168
  # A list of Redis instances in the project in the specified location,
169
169
  # or across all locations.
170
170
  #
171
- # If the +location_id+ in the parent field of the request is "-", all regions
171
+ # If the `location_id` in the parent field of the request is "-", all regions
172
172
  # available to the project are queried, and the results aggregated.
173
173
  # If in such an aggregated query a location is unavailable, a dummy Redis
174
174
  # entry is included in the response with the "name" field set to a value of
@@ -185,16 +185,16 @@ module Google
185
185
  # @!attribute [rw] name
186
186
  # @return [String]
187
187
  # Required. Redis instance resource name using the form:
188
- # +projects/\\{project_id}/locations/\\{location_id}/instances/\\{instance_id}+
189
- # where +location_id+ refers to a GCP region
188
+ # `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
189
+ # where `location_id` refers to a GCP region
190
190
  class GetInstanceRequest; end
191
191
 
192
192
  # Request for {Google::Cloud::Redis::V1beta1::CloudRedis::CreateInstance CreateInstance}.
193
193
  # @!attribute [rw] parent
194
194
  # @return [String]
195
195
  # Required. The resource name of the instance location using the form:
196
- # +projects/\\{project_id}/locations/\\{location_id}+
197
- # where +location_id+ refers to a GCP region
196
+ # `projects/{project_id}/locations/{location_id}`
197
+ # where `location_id` refers to a GCP region
198
198
  # @!attribute [rw] instance_id
199
199
  # @return [String]
200
200
  # Required. The logical name of the Redis instance in the customer project
@@ -216,10 +216,10 @@ module Google
216
216
  # Required. Mask of fields to update. At least one path must be supplied in
217
217
  # this field. The elements of the repeated paths field may only include these
218
218
  # fields from {CloudRedis::Instance Instance}:
219
- # * +display_name+
220
- # * +labels+
221
- # * +memory_size_gb+
222
- # * +redis_config+
219
+ # * `display_name`
220
+ # * `labels`
221
+ # * `memory_size_gb`
222
+ # * `redis_config`
223
223
  # @!attribute [rw] instance
224
224
  # @return [Google::Cloud::Redis::V1beta1::Instance]
225
225
  # Required. Update description.
@@ -230,19 +230,19 @@ module Google
230
230
  # @!attribute [rw] name
231
231
  # @return [String]
232
232
  # Required. Redis instance resource name using the form:
233
- # +projects/\\{project_id}/locations/\\{location_id}/instances/\\{instance_id}+
234
- # where +location_id+ refers to a GCP region
233
+ # `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
234
+ # where `location_id` refers to a GCP region
235
235
  class DeleteInstanceRequest; end
236
236
 
237
237
  # This location metadata represents additional configuration options for a
238
238
  # given location where a Redis instance may be created. All fields are output
239
239
  # only. It is returned as content of the
240
- # +google.cloud.location.Location.metadata+ field.
240
+ # `google.cloud.location.Location.metadata` field.
241
241
  # @!attribute [rw] available_zones
242
242
  # @return [Hash{String => Google::Cloud::Redis::V1beta1::ZoneMetadata}]
243
243
  # Output only. The set of available zones in the location. The map is keyed
244
244
  # by the lowercase ID of each zone, as defined by GCE. These keys can be
245
- # specified in +location_id+ or +alternative_location_id+ fields when
245
+ # specified in `location_id` or `alternative_location_id` fields when
246
246
  # creating a Redis instance.
247
247
  class LocationMetadata; end
248
248
 
@@ -21,7 +21,7 @@ module Google
21
21
  # @return [String]
22
22
  # The server-assigned name, which is only unique within the same service that
23
23
  # originally returns it. If you use the default HTTP mapping, the
24
- # +name+ should have the format of +operations/some/unique/name+.
24
+ # `name` should have the format of `operations/some/unique/name`.
25
25
  # @!attribute [rw] metadata
26
26
  # @return [Google::Protobuf::Any]
27
27
  # Service-specific metadata associated with the operation. It typically
@@ -30,8 +30,8 @@ module Google
30
30
  # long-running operation should document the metadata type, if any.
31
31
  # @!attribute [rw] done
32
32
  # @return [true, false]
33
- # If the value is +false+, it means the operation is still in progress.
34
- # If true, the operation is completed, and either +error+ or +response+ is
33
+ # If the value is `false`, it means the operation is still in progress.
34
+ # If true, the operation is completed, and either `error` or `response` is
35
35
  # available.
36
36
  # @!attribute [rw] error
37
37
  # @return [Google::Rpc::Status]
@@ -39,13 +39,13 @@ module Google
39
39
  # @!attribute [rw] response
40
40
  # @return [Google::Protobuf::Any]
41
41
  # The normal response of the operation in case of success. If the original
42
- # method returns no data on success, such as +Delete+, the response is
43
- # +google.protobuf.Empty+. If the original method is standard
44
- # +Get+/+Create+/+Update+, the response should be the resource. For other
45
- # methods, the response should have the type +XxxResponse+, where +Xxx+
42
+ # method returns no data on success, such as `Delete`, the response is
43
+ # `google.protobuf.Empty`. If the original method is standard
44
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
45
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
46
46
  # is the original method name. For example, if the original method name
47
- # is +TakeSnapshot()+, the inferred response type is
48
- # +TakeSnapshotResponse+.
47
+ # is `TakeSnapshot()`, the inferred response type is
48
+ # `TakeSnapshotResponse`.
49
49
  class Operation; end
50
50
 
51
51
  # The request message for {Google::Longrunning::Operations::GetOperation Operations::GetOperation}.