Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / redis_v1beta1.projects.locations.instances.html
blob: 6cb948f683fec64f5a850a3784dbef000750d5df [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="redis_v1beta1.html">Google Cloud Memorystore for Redis API</a> . <a href="redis_v1beta1.projects.html">projects</a> . <a href="redis_v1beta1.projects.locations.html">locations</a> . <a href="redis_v1beta1.projects.locations.instances.html">instances</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Creates a Redis instance based on the specified tier and memory size.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a specific Redis instance. Instance stops serving and data is</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <code><a href="#export">export(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Export Redis instance data into a Redis RDB format file in Cloud Storage.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]87 <code><a href="#failover">failover(name, body=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Initiates a failover of the master node to current replica node for a</p>
89<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]90 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
91<p class="firstline">Gets the details of a specific Redis instance.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#import_">import_(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="firstline">Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.</p>
95<p class="toc_element">
96 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
97<p class="firstline">Lists all Redis instances owned by a project in either the specified</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]102 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103<p class="firstline">Updates the metadata and configuration of a specific Redis instance.</p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]104<p class="toc_element">
105 <code><a href="#upgrade">upgrade(name, body=None, x__xgafv=None)</a></code></p>
106<p class="firstline">Upgrades Redis instance to the newer Redis version specified in the</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]107<h3>Method Details</h3>
108<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]109 <code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110 <pre>Creates a Redis instance based on the specified tier and memory size.
111
112By default, the instance is accessible from the project's
113[default network](/compute/docs/networks-and-firewalls#networks).
114
115The creation is executed asynchronously and callers may check the returned
116operation to track its progress. Once the operation is completed the Redis
117instance will be fully functional. Completed longrunning.Operation will
118contain the new instance object in the response field.
119
120The returned operation is automatically deleted after a few hours, so there
121is no need to call DeleteOperation.
122
123Args:
124 parent: string, Required. The resource name of the instance location using the form:
125 `projects/{project_id}/locations/{location_id}`
126where `location_id` refers to a GCP region. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]127 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128 The object takes the form of:
129
130{ # A Google Cloud Redis instance.
131 "labels": { # Resource labels to represent user provided metadata
132 "a_key": "A String",
133 },
134 "displayName": "A String", # An arbitrary and optional user-provided name for the instance.
135 "name": "A String", # Required. Unique name of the resource in this scope including project and
136 # location using the form:
137 # `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
138 #
139 # Note: Redis instances are managed and addressed at regional level so
140 # location_id here refers to a GCP region; however, users may choose which
141 # specific zone (or collection of zones for cross-zone instances) an instance
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]142 # should be provisioned in. Refer to location_id and
143 # alternative_location_id fields for more details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]144 "alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance
145 # against zonal failures by provisioning it across two zones. If provided, it
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]146 # must be a different zone from the one provided in location_id.
147 "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
148 # the service will choose a zone for the instance. For STANDARD_HA tier,
149 # instances will be created across two zones for protection against zonal
150 # failures. If alternative_location_id is also provided, it must be
151 # different from location_id.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]152 "reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this
153 # instance. If not provided, the service will choose an unused /29 block,
154 # for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
155 # and non-overlapping with existing subnets in an authorized network.
156 "redisVersion": "A String", # Optional. The version of Redis software.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]157 # If not provided, latest supported version will be used. Currently, the
158 # supported values are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]159 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]160 # * `REDIS_3_2` for Redis 3.2 compatibility
161 # * `REDIS_4_0` for Redis 4.0 compatibility (default)
162 # * `REDIS_5_0` for Redis 5.0 compatibility
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]163 "host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by
164 # clients to connect to the service.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]165 "createTime": "A String", # Output only. The time the instance was created.
166 "memorySizeGb": 42, # Required. Redis memory size in GiB.
167 "state": "A String", # Output only. The current state of this instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]168 "persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to
169 # transfer data to/from Cloud Storage. Format is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]170 # "serviceAccount:&lt;service_account_email&gt;". The value may change over time
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]171 # for a given instance so should be checked before each import/export
172 # operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]173 "statusMessage": "A String", # Output only. Additional information about the current status of this
174 # instance, if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]175 "redisConfigs": { # Optional. Redis configuration parameters, according to
176 # http://redis.io/topics/config. Currently, the only supported parameters
177 # are:
178 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]179 # Redis version 3.2 and newer:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]180 #
181 # * maxmemory-policy
182 # * notify-keyspace-events
183 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]184 # Redis version 4.0 and newer:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]185 #
186 # * activedefrag
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]187 # * lfu-decay-time
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]188 # * lfu-log-factor
189 # * maxmemory-gb
190 #
191 # Redis version 5.0 and newer:
192 #
193 # * stream-node-max-bytes
194 # * stream-node-max-entries
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]195 "a_key": "A String",
196 },
197 "tier": "A String", # Required. The service tier of the instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]198 "connectMode": "A String", # Optional. The network connect mode of the Redis instance.
199 # If not provided, the connect mode defaults to DIRECT_PEERING.
200 "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
201 # Tier instances, this will always be the same as the location_id
202 # provided by the user at creation time. For Standard Tier instances,
203 # this can be either location_id or alternative_location_id and can
204 # change after a failover event.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205 "port": 42, # Output only. The port number of the exposed Redis endpoint.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]206 "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine
207 # [network](/compute/docs/networks-and-firewalls#networks) to which the
208 # instance is connected. If left unspecified, the `default` network
209 # will be used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]210}
211
212 instanceId: string, Required. The logical name of the Redis instance in the customer project
213with the following restrictions:
214
215* Must contain only lowercase letters, numbers, and hyphens.
216* Must start with a letter.
217* Must be between 1-40 characters.
218* Must end with a number or a letter.
219* Must be unique within the customer project / location
220 x__xgafv: string, V1 error format.
221 Allowed values
222 1 - v1 error format
223 2 - v2 error format
224
225Returns:
226 An object of the form:
227
228 { # This resource represents a long-running operation that is the result of a
229 # network API call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]230 "metadata": { # {
231 #
232 # `createTime`: The time the operation was created.
233 #
234 # `endTime`: The time the operation finished running.
235 #
236 # `target`: Server-defined resource path for the target of the operation.
237 #
238 # `verb`: Name of the verb executed by the operation.
239 #
240 # `statusDetail`: Human-readable status of the operation, if any.
241 #
242 # `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
243 #
244 # `apiVersion`: API version used to start the operation.
245 #
246 # }
247 "a_key": "", # Properties of the object. Contains field @type with type URL.
248 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]249 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
250 # different programming environments, including REST APIs and RPC APIs. It is
251 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
252 # three pieces of data: error code, error message, and error details.
253 #
254 # You can find out more about this error model and how to work with it in the
255 # [API Design Guide](https://cloud.google.com/apis/design/errors).
256 "message": "A String", # A developer-facing error message, which should be in English. Any
257 # user-facing error message should be localized and sent in the
258 # google.rpc.Status.details field, or localized by the client.
259 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
260 "details": [ # A list of messages that carry the error details. There is a common set of
261 # message types for APIs to use.
262 {
263 "a_key": "", # Properties of the object. Contains field @type with type URL.
264 },
265 ],
266 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]267 "done": True or False, # If the value is `false`, it means the operation is still in progress.
268 # If `true`, the operation is completed, and either `error` or `response` is
269 # available.
270 "response": { # The normal response of the operation in case of success. If the original
271 # method returns no data on success, such as `Delete`, the response is
272 # `google.protobuf.Empty`. If the original method is standard
273 # `Get`/`Create`/`Update`, the response should be the resource. For other
274 # methods, the response should have the type `XxxResponse`, where `Xxx`
275 # is the original method name. For example, if the original method name
276 # is `TakeSnapshot()`, the inferred response type is
277 # `TakeSnapshotResponse`.
278 "a_key": "", # Properties of the object. Contains field @type with type URL.
279 },
280 "name": "A String", # The server-assigned name, which is only unique within the same service that
281 # originally returns it. If you use the default HTTP mapping, the
282 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]283 }</pre>
284</div>
285
286<div class="method">
287 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
288 <pre>Deletes a specific Redis instance. Instance stops serving and data is
289deleted.
290
291Args:
292 name: string, Required. Redis instance resource name using the form:
293 `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
294where `location_id` refers to a GCP region. (required)
295 x__xgafv: string, V1 error format.
296 Allowed values
297 1 - v1 error format
298 2 - v2 error format
299
300Returns:
301 An object of the form:
302
303 { # This resource represents a long-running operation that is the result of a
304 # network API call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]305 "metadata": { # {
306 #
307 # `createTime`: The time the operation was created.
308 #
309 # `endTime`: The time the operation finished running.
310 #
311 # `target`: Server-defined resource path for the target of the operation.
312 #
313 # `verb`: Name of the verb executed by the operation.
314 #
315 # `statusDetail`: Human-readable status of the operation, if any.
316 #
317 # `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
318 #
319 # `apiVersion`: API version used to start the operation.
320 #
321 # }
322 "a_key": "", # Properties of the object. Contains field @type with type URL.
323 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]324 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
325 # different programming environments, including REST APIs and RPC APIs. It is
326 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
327 # three pieces of data: error code, error message, and error details.
328 #
329 # You can find out more about this error model and how to work with it in the
330 # [API Design Guide](https://cloud.google.com/apis/design/errors).
331 "message": "A String", # A developer-facing error message, which should be in English. Any
332 # user-facing error message should be localized and sent in the
333 # google.rpc.Status.details field, or localized by the client.
334 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
335 "details": [ # A list of messages that carry the error details. There is a common set of
336 # message types for APIs to use.
337 {
338 "a_key": "", # Properties of the object. Contains field @type with type URL.
339 },
340 ],
341 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]342 "done": True or False, # If the value is `false`, it means the operation is still in progress.
343 # If `true`, the operation is completed, and either `error` or `response` is
344 # available.
345 "response": { # The normal response of the operation in case of success. If the original
346 # method returns no data on success, such as `Delete`, the response is
347 # `google.protobuf.Empty`. If the original method is standard
348 # `Get`/`Create`/`Update`, the response should be the resource. For other
349 # methods, the response should have the type `XxxResponse`, where `Xxx`
350 # is the original method name. For example, if the original method name
351 # is `TakeSnapshot()`, the inferred response type is
352 # `TakeSnapshotResponse`.
353 "a_key": "", # Properties of the object. Contains field @type with type URL.
354 },
355 "name": "A String", # The server-assigned name, which is only unique within the same service that
356 # originally returns it. If you use the default HTTP mapping, the
357 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]358 }</pre>
359</div>
360
361<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]362 <code class="details" id="export">export(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]363 <pre>Export Redis instance data into a Redis RDB format file in Cloud Storage.
364
365Redis will continue serving during this operation.
366
367The returned operation is automatically deleted after a few hours, so
368there is no need to call DeleteOperation.
369
370Args:
371 name: string, Required. Redis instance resource name using the form:
372 `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
373where `location_id` refers to a GCP region. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]374 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]375 The object takes the form of:
376
377{ # Request for Export.
378 "outputConfig": { # The output content # Required. Specify data to be exported.
379 "gcsDestination": { # The Cloud Storage location for the output content # Google Cloud Storage destination for output content.
380 "uri": "A String", # Required. Data destination URI (e.g.
381 # 'gs://my_bucket/my_object'). Existing files will be overwritten.
382 },
383 },
384 }
385
386 x__xgafv: string, V1 error format.
387 Allowed values
388 1 - v1 error format
389 2 - v2 error format
390
391Returns:
392 An object of the form:
393
394 { # This resource represents a long-running operation that is the result of a
395 # network API call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]396 "metadata": { # {
397 #
398 # `createTime`: The time the operation was created.
399 #
400 # `endTime`: The time the operation finished running.
401 #
402 # `target`: Server-defined resource path for the target of the operation.
403 #
404 # `verb`: Name of the verb executed by the operation.
405 #
406 # `statusDetail`: Human-readable status of the operation, if any.
407 #
408 # `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
409 #
410 # `apiVersion`: API version used to start the operation.
411 #
412 # }
413 "a_key": "", # Properties of the object. Contains field @type with type URL.
414 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]415 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
416 # different programming environments, including REST APIs and RPC APIs. It is
417 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
418 # three pieces of data: error code, error message, and error details.
419 #
420 # You can find out more about this error model and how to work with it in the
421 # [API Design Guide](https://cloud.google.com/apis/design/errors).
422 "message": "A String", # A developer-facing error message, which should be in English. Any
423 # user-facing error message should be localized and sent in the
424 # google.rpc.Status.details field, or localized by the client.
425 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
426 "details": [ # A list of messages that carry the error details. There is a common set of
427 # message types for APIs to use.
428 {
429 "a_key": "", # Properties of the object. Contains field @type with type URL.
430 },
431 ],
432 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]433 "done": True or False, # If the value is `false`, it means the operation is still in progress.
434 # If `true`, the operation is completed, and either `error` or `response` is
435 # available.
436 "response": { # The normal response of the operation in case of success. If the original
437 # method returns no data on success, such as `Delete`, the response is
438 # `google.protobuf.Empty`. If the original method is standard
439 # `Get`/`Create`/`Update`, the response should be the resource. For other
440 # methods, the response should have the type `XxxResponse`, where `Xxx`
441 # is the original method name. For example, if the original method name
442 # is `TakeSnapshot()`, the inferred response type is
443 # `TakeSnapshotResponse`.
444 "a_key": "", # Properties of the object. Contains field @type with type URL.
445 },
446 "name": "A String", # The server-assigned name, which is only unique within the same service that
447 # originally returns it. If you use the default HTTP mapping, the
448 # `name` should be a resource name ending with `operations/{unique_id}`.
449 }</pre>
450</div>
451
452<div class="method">
453 <code class="details" id="failover">failover(name, body=None, x__xgafv=None)</code>
454 <pre>Initiates a failover of the master node to current replica node for a
455specific STANDARD tier Cloud Memorystore for Redis instance.
456
457Args:
458 name: string, Required. Redis instance resource name using the form:
459 `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
460where `location_id` refers to a GCP region. (required)
461 body: object, The request body.
462 The object takes the form of:
463
464{ # Request for Failover.
465 "dataProtectionMode": "A String", # Optional. Available data protection modes that the user can choose. If it's
466 # unspecified, data protection mode will be LIMITED_DATA_LOSS by default.
467 }
468
469 x__xgafv: string, V1 error format.
470 Allowed values
471 1 - v1 error format
472 2 - v2 error format
473
474Returns:
475 An object of the form:
476
477 { # This resource represents a long-running operation that is the result of a
478 # network API call.
479 "metadata": { # {
480 #
481 # `createTime`: The time the operation was created.
482 #
483 # `endTime`: The time the operation finished running.
484 #
485 # `target`: Server-defined resource path for the target of the operation.
486 #
487 # `verb`: Name of the verb executed by the operation.
488 #
489 # `statusDetail`: Human-readable status of the operation, if any.
490 #
491 # `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
492 #
493 # `apiVersion`: API version used to start the operation.
494 #
495 # }
496 "a_key": "", # Properties of the object. Contains field @type with type URL.
497 },
498 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
499 # different programming environments, including REST APIs and RPC APIs. It is
500 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
501 # three pieces of data: error code, error message, and error details.
502 #
503 # You can find out more about this error model and how to work with it in the
504 # [API Design Guide](https://cloud.google.com/apis/design/errors).
505 "message": "A String", # A developer-facing error message, which should be in English. Any
506 # user-facing error message should be localized and sent in the
507 # google.rpc.Status.details field, or localized by the client.
508 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
509 "details": [ # A list of messages that carry the error details. There is a common set of
510 # message types for APIs to use.
511 {
512 "a_key": "", # Properties of the object. Contains field @type with type URL.
513 },
514 ],
515 },
516 "done": True or False, # If the value is `false`, it means the operation is still in progress.
517 # If `true`, the operation is completed, and either `error` or `response` is
518 # available.
519 "response": { # The normal response of the operation in case of success. If the original
520 # method returns no data on success, such as `Delete`, the response is
521 # `google.protobuf.Empty`. If the original method is standard
522 # `Get`/`Create`/`Update`, the response should be the resource. For other
523 # methods, the response should have the type `XxxResponse`, where `Xxx`
524 # is the original method name. For example, if the original method name
525 # is `TakeSnapshot()`, the inferred response type is
526 # `TakeSnapshotResponse`.
527 "a_key": "", # Properties of the object. Contains field @type with type URL.
528 },
529 "name": "A String", # The server-assigned name, which is only unique within the same service that
530 # originally returns it. If you use the default HTTP mapping, the
531 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]532 }</pre>
533</div>
534
535<div class="method">
536 <code class="details" id="get">get(name, x__xgafv=None)</code>
537 <pre>Gets the details of a specific Redis instance.
538
539Args:
540 name: string, Required. Redis instance resource name using the form:
541 `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
542where `location_id` refers to a GCP region. (required)
543 x__xgafv: string, V1 error format.
544 Allowed values
545 1 - v1 error format
546 2 - v2 error format
547
548Returns:
549 An object of the form:
550
551 { # A Google Cloud Redis instance.
552 "labels": { # Resource labels to represent user provided metadata
553 "a_key": "A String",
554 },
555 "displayName": "A String", # An arbitrary and optional user-provided name for the instance.
556 "name": "A String", # Required. Unique name of the resource in this scope including project and
557 # location using the form:
558 # `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
559 #
560 # Note: Redis instances are managed and addressed at regional level so
561 # location_id here refers to a GCP region; however, users may choose which
562 # specific zone (or collection of zones for cross-zone instances) an instance
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]563 # should be provisioned in. Refer to location_id and
564 # alternative_location_id fields for more details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]565 "alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance
566 # against zonal failures by provisioning it across two zones. If provided, it
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]567 # must be a different zone from the one provided in location_id.
568 "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
569 # the service will choose a zone for the instance. For STANDARD_HA tier,
570 # instances will be created across two zones for protection against zonal
571 # failures. If alternative_location_id is also provided, it must be
572 # different from location_id.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]573 "reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this
574 # instance. If not provided, the service will choose an unused /29 block,
575 # for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
576 # and non-overlapping with existing subnets in an authorized network.
577 "redisVersion": "A String", # Optional. The version of Redis software.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]578 # If not provided, latest supported version will be used. Currently, the
579 # supported values are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]580 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]581 # * `REDIS_3_2` for Redis 3.2 compatibility
582 # * `REDIS_4_0` for Redis 4.0 compatibility (default)
583 # * `REDIS_5_0` for Redis 5.0 compatibility
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]584 "host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by
585 # clients to connect to the service.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]586 "createTime": "A String", # Output only. The time the instance was created.
587 "memorySizeGb": 42, # Required. Redis memory size in GiB.
588 "state": "A String", # Output only. The current state of this instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]589 "persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to
590 # transfer data to/from Cloud Storage. Format is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]591 # "serviceAccount:&lt;service_account_email&gt;". The value may change over time
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]592 # for a given instance so should be checked before each import/export
593 # operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]594 "statusMessage": "A String", # Output only. Additional information about the current status of this
595 # instance, if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]596 "redisConfigs": { # Optional. Redis configuration parameters, according to
597 # http://redis.io/topics/config. Currently, the only supported parameters
598 # are:
599 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]600 # Redis version 3.2 and newer:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]601 #
602 # * maxmemory-policy
603 # * notify-keyspace-events
604 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]605 # Redis version 4.0 and newer:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]606 #
607 # * activedefrag
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]608 # * lfu-decay-time
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]609 # * lfu-log-factor
610 # * maxmemory-gb
611 #
612 # Redis version 5.0 and newer:
613 #
614 # * stream-node-max-bytes
615 # * stream-node-max-entries
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]616 "a_key": "A String",
617 },
618 "tier": "A String", # Required. The service tier of the instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]619 "connectMode": "A String", # Optional. The network connect mode of the Redis instance.
620 # If not provided, the connect mode defaults to DIRECT_PEERING.
621 "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
622 # Tier instances, this will always be the same as the location_id
623 # provided by the user at creation time. For Standard Tier instances,
624 # this can be either location_id or alternative_location_id and can
625 # change after a failover event.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]626 "port": 42, # Output only. The port number of the exposed Redis endpoint.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]627 "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine
628 # [network](/compute/docs/networks-and-firewalls#networks) to which the
629 # instance is connected. If left unspecified, the `default` network
630 # will be used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]631 }</pre>
632</div>
633
634<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]635 <code class="details" id="import_">import_(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]636 <pre>Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.
637
638Redis may stop serving during this operation. Instance state will be
639IMPORTING for entire operation. When complete, the instance will contain
640only data from the imported file.
641
642The returned operation is automatically deleted after a few hours, so
643there is no need to call DeleteOperation.
644
645Args:
646 name: string, Required. Redis instance resource name using the form:
647 `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
648where `location_id` refers to a GCP region. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]649 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]650 The object takes the form of:
651
652{ # Request for Import.
653 "inputConfig": { # The input content # Required. Specify data to be imported.
654 "gcsSource": { # The Cloud Storage location for the input content # Google Cloud Storage location where input content is located.
655 "uri": "A String", # Required. Source data URI. (e.g. 'gs://my_bucket/my_object').
656 },
657 },
658 }
659
660 x__xgafv: string, V1 error format.
661 Allowed values
662 1 - v1 error format
663 2 - v2 error format
664
665Returns:
666 An object of the form:
667
668 { # This resource represents a long-running operation that is the result of a
669 # network API call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]670 "metadata": { # {
671 #
672 # `createTime`: The time the operation was created.
673 #
674 # `endTime`: The time the operation finished running.
675 #
676 # `target`: Server-defined resource path for the target of the operation.
677 #
678 # `verb`: Name of the verb executed by the operation.
679 #
680 # `statusDetail`: Human-readable status of the operation, if any.
681 #
682 # `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
683 #
684 # `apiVersion`: API version used to start the operation.
685 #
686 # }
687 "a_key": "", # Properties of the object. Contains field @type with type URL.
688 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]689 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
690 # different programming environments, including REST APIs and RPC APIs. It is
691 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
692 # three pieces of data: error code, error message, and error details.
693 #
694 # You can find out more about this error model and how to work with it in the
695 # [API Design Guide](https://cloud.google.com/apis/design/errors).
696 "message": "A String", # A developer-facing error message, which should be in English. Any
697 # user-facing error message should be localized and sent in the
698 # google.rpc.Status.details field, or localized by the client.
699 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
700 "details": [ # A list of messages that carry the error details. There is a common set of
701 # message types for APIs to use.
702 {
703 "a_key": "", # Properties of the object. Contains field @type with type URL.
704 },
705 ],
706 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]707 "done": True or False, # If the value is `false`, it means the operation is still in progress.
708 # If `true`, the operation is completed, and either `error` or `response` is
709 # available.
710 "response": { # The normal response of the operation in case of success. If the original
711 # method returns no data on success, such as `Delete`, the response is
712 # `google.protobuf.Empty`. If the original method is standard
713 # `Get`/`Create`/`Update`, the response should be the resource. For other
714 # methods, the response should have the type `XxxResponse`, where `Xxx`
715 # is the original method name. For example, if the original method name
716 # is `TakeSnapshot()`, the inferred response type is
717 # `TakeSnapshotResponse`.
718 "a_key": "", # Properties of the object. Contains field @type with type URL.
719 },
720 "name": "A String", # The server-assigned name, which is only unique within the same service that
721 # originally returns it. If you use the default HTTP mapping, the
722 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]723 }</pre>
724</div>
725
726<div class="method">
727 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
728 <pre>Lists all Redis instances owned by a project in either the specified
729location (region) or all locations.
730
731The location should have the following format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]732
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]733* `projects/{project_id}/locations/{location_id}`
734
735If `location_id` is specified as `-` (wildcard), then all regions
736available to the project are queried, and the results are aggregated.
737
738Args:
739 parent: string, Required. The resource name of the instance location using the form:
740 `projects/{project_id}/locations/{location_id}`
741where `location_id` refers to a GCP region. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]742 pageToken: string, The `next_page_token` value returned from a previous
743ListInstances request, if any.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]744 x__xgafv: string, V1 error format.
745 Allowed values
746 1 - v1 error format
747 2 - v2 error format
748 pageSize: integer, The maximum number of items to return.
749
750If not specified, a default value of 1000 will be used by the service.
751Regardless of the page_size value, the response may include a partial list
752and a caller should only rely on response's
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]753`next_page_token`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]754to determine if there are more instances left to be queried.
755
756Returns:
757 An object of the form:
758
759 { # Response for ListInstances.
760 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more
761 # results in the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]762 "instances": [ # A list of Redis instances in the project in the specified location,
763 # or across all locations.
764 #
765 # If the `location_id` in the parent field of the request is "-", all regions
766 # available to the project are queried, and the results aggregated.
767 # If in such an aggregated query a location is unavailable, a dummy Redis
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]768 # entry is included in the response with the `name` field set to a value of
769 # the form `projects/{project_id}/locations/{location_id}/instances/`- and
770 # the `status` field set to ERROR and `status_message` field set to "location
771 # not available for ListInstances".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]772 { # A Google Cloud Redis instance.
773 "labels": { # Resource labels to represent user provided metadata
774 "a_key": "A String",
775 },
776 "displayName": "A String", # An arbitrary and optional user-provided name for the instance.
777 "name": "A String", # Required. Unique name of the resource in this scope including project and
778 # location using the form:
779 # `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
780 #
781 # Note: Redis instances are managed and addressed at regional level so
782 # location_id here refers to a GCP region; however, users may choose which
783 # specific zone (or collection of zones for cross-zone instances) an instance
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]784 # should be provisioned in. Refer to location_id and
785 # alternative_location_id fields for more details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]786 "alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance
787 # against zonal failures by provisioning it across two zones. If provided, it
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]788 # must be a different zone from the one provided in location_id.
789 "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
790 # the service will choose a zone for the instance. For STANDARD_HA tier,
791 # instances will be created across two zones for protection against zonal
792 # failures. If alternative_location_id is also provided, it must be
793 # different from location_id.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]794 "reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this
795 # instance. If not provided, the service will choose an unused /29 block,
796 # for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
797 # and non-overlapping with existing subnets in an authorized network.
798 "redisVersion": "A String", # Optional. The version of Redis software.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]799 # If not provided, latest supported version will be used. Currently, the
800 # supported values are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]801 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]802 # * `REDIS_3_2` for Redis 3.2 compatibility
803 # * `REDIS_4_0` for Redis 4.0 compatibility (default)
804 # * `REDIS_5_0` for Redis 5.0 compatibility
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]805 "host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by
806 # clients to connect to the service.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]807 "createTime": "A String", # Output only. The time the instance was created.
808 "memorySizeGb": 42, # Required. Redis memory size in GiB.
809 "state": "A String", # Output only. The current state of this instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]810 "persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to
811 # transfer data to/from Cloud Storage. Format is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]812 # "serviceAccount:&lt;service_account_email&gt;". The value may change over time
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]813 # for a given instance so should be checked before each import/export
814 # operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]815 "statusMessage": "A String", # Output only. Additional information about the current status of this
816 # instance, if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]817 "redisConfigs": { # Optional. Redis configuration parameters, according to
818 # http://redis.io/topics/config. Currently, the only supported parameters
819 # are:
820 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]821 # Redis version 3.2 and newer:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]822 #
823 # * maxmemory-policy
824 # * notify-keyspace-events
825 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]826 # Redis version 4.0 and newer:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]827 #
828 # * activedefrag
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]829 # * lfu-decay-time
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]830 # * lfu-log-factor
831 # * maxmemory-gb
832 #
833 # Redis version 5.0 and newer:
834 #
835 # * stream-node-max-bytes
836 # * stream-node-max-entries
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]837 "a_key": "A String",
838 },
839 "tier": "A String", # Required. The service tier of the instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]840 "connectMode": "A String", # Optional. The network connect mode of the Redis instance.
841 # If not provided, the connect mode defaults to DIRECT_PEERING.
842 "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
843 # Tier instances, this will always be the same as the location_id
844 # provided by the user at creation time. For Standard Tier instances,
845 # this can be either location_id or alternative_location_id and can
846 # change after a failover event.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]847 "port": 42, # Output only. The port number of the exposed Redis endpoint.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]848 "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine
849 # [network](/compute/docs/networks-and-firewalls#networks) to which the
850 # instance is connected. If left unspecified, the `default` network
851 # will be used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]852 },
853 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]854 "unreachable": [ # Locations that could not be reached.
855 "A String",
856 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]857 }</pre>
858</div>
859
860<div class="method">
861 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
862 <pre>Retrieves the next page of results.
863
864Args:
865 previous_request: The request for the previous page. (required)
866 previous_response: The response from the request for the previous page. (required)
867
868Returns:
869 A request object that you can call 'execute()' on to request the next
870 page. Returns None if there are no more items in the collection.
871 </pre>
872</div>
873
874<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]875 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]876 <pre>Updates the metadata and configuration of a specific Redis instance.
877
878Completed longrunning.Operation will contain the new instance object
879in the response field. The returned operation is automatically deleted
880after a few hours, so there is no need to call DeleteOperation.
881
882Args:
883 name: string, Required. Unique name of the resource in this scope including project and
884location using the form:
885 `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
886
887Note: Redis instances are managed and addressed at regional level so
888location_id here refers to a GCP region; however, users may choose which
889specific zone (or collection of zones for cross-zone instances) an instance
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]890should be provisioned in. Refer to location_id and
891alternative_location_id fields for more details. (required)
892 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]893 The object takes the form of:
894
895{ # A Google Cloud Redis instance.
896 "labels": { # Resource labels to represent user provided metadata
897 "a_key": "A String",
898 },
899 "displayName": "A String", # An arbitrary and optional user-provided name for the instance.
900 "name": "A String", # Required. Unique name of the resource in this scope including project and
901 # location using the form:
902 # `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
903 #
904 # Note: Redis instances are managed and addressed at regional level so
905 # location_id here refers to a GCP region; however, users may choose which
906 # specific zone (or collection of zones for cross-zone instances) an instance
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]907 # should be provisioned in. Refer to location_id and
908 # alternative_location_id fields for more details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]909 "alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance
910 # against zonal failures by provisioning it across two zones. If provided, it
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]911 # must be a different zone from the one provided in location_id.
912 "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
913 # the service will choose a zone for the instance. For STANDARD_HA tier,
914 # instances will be created across two zones for protection against zonal
915 # failures. If alternative_location_id is also provided, it must be
916 # different from location_id.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]917 "reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this
918 # instance. If not provided, the service will choose an unused /29 block,
919 # for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
920 # and non-overlapping with existing subnets in an authorized network.
921 "redisVersion": "A String", # Optional. The version of Redis software.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]922 # If not provided, latest supported version will be used. Currently, the
923 # supported values are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]924 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]925 # * `REDIS_3_2` for Redis 3.2 compatibility
926 # * `REDIS_4_0` for Redis 4.0 compatibility (default)
927 # * `REDIS_5_0` for Redis 5.0 compatibility
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]928 "host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by
929 # clients to connect to the service.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]930 "createTime": "A String", # Output only. The time the instance was created.
931 "memorySizeGb": 42, # Required. Redis memory size in GiB.
932 "state": "A String", # Output only. The current state of this instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]933 "persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to
934 # transfer data to/from Cloud Storage. Format is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]935 # "serviceAccount:&lt;service_account_email&gt;". The value may change over time
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]936 # for a given instance so should be checked before each import/export
937 # operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]938 "statusMessage": "A String", # Output only. Additional information about the current status of this
939 # instance, if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]940 "redisConfigs": { # Optional. Redis configuration parameters, according to
941 # http://redis.io/topics/config. Currently, the only supported parameters
942 # are:
943 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]944 # Redis version 3.2 and newer:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]945 #
946 # * maxmemory-policy
947 # * notify-keyspace-events
948 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]949 # Redis version 4.0 and newer:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]950 #
951 # * activedefrag
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]952 # * lfu-decay-time
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]953 # * lfu-log-factor
954 # * maxmemory-gb
955 #
956 # Redis version 5.0 and newer:
957 #
958 # * stream-node-max-bytes
959 # * stream-node-max-entries
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]960 "a_key": "A String",
961 },
962 "tier": "A String", # Required. The service tier of the instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]963 "connectMode": "A String", # Optional. The network connect mode of the Redis instance.
964 # If not provided, the connect mode defaults to DIRECT_PEERING.
965 "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
966 # Tier instances, this will always be the same as the location_id
967 # provided by the user at creation time. For Standard Tier instances,
968 # this can be either location_id or alternative_location_id and can
969 # change after a failover event.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]970 "port": 42, # Output only. The port number of the exposed Redis endpoint.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]971 "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine
972 # [network](/compute/docs/networks-and-firewalls#networks) to which the
973 # instance is connected. If left unspecified, the `default` network
974 # will be used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]975}
976
977 updateMask: string, Required. Mask of fields to update. At least one path must be supplied in
978this field. The elements of the repeated paths field may only include these
979fields from Instance:
980
981 * `displayName`
982 * `labels`
983 * `memorySizeGb`
984 * `redisConfig`
985 x__xgafv: string, V1 error format.
986 Allowed values
987 1 - v1 error format
988 2 - v2 error format
989
990Returns:
991 An object of the form:
992
993 { # This resource represents a long-running operation that is the result of a
994 # network API call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]995 "metadata": { # {
996 #
997 # `createTime`: The time the operation was created.
998 #
999 # `endTime`: The time the operation finished running.
1000 #
1001 # `target`: Server-defined resource path for the target of the operation.
1002 #
1003 # `verb`: Name of the verb executed by the operation.
1004 #
1005 # `statusDetail`: Human-readable status of the operation, if any.
1006 #
1007 # `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
1008 #
1009 # `apiVersion`: API version used to start the operation.
1010 #
1011 # }
1012 "a_key": "", # Properties of the object. Contains field @type with type URL.
1013 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1014 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
1015 # different programming environments, including REST APIs and RPC APIs. It is
1016 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1017 # three pieces of data: error code, error message, and error details.
1018 #
1019 # You can find out more about this error model and how to work with it in the
1020 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1021 "message": "A String", # A developer-facing error message, which should be in English. Any
1022 # user-facing error message should be localized and sent in the
1023 # google.rpc.Status.details field, or localized by the client.
1024 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
1025 "details": [ # A list of messages that carry the error details. There is a common set of
1026 # message types for APIs to use.
1027 {
1028 "a_key": "", # Properties of the object. Contains field @type with type URL.
1029 },
1030 ],
1031 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1032 "done": True or False, # If the value is `false`, it means the operation is still in progress.
1033 # If `true`, the operation is completed, and either `error` or `response` is
1034 # available.
1035 "response": { # The normal response of the operation in case of success. If the original
1036 # method returns no data on success, such as `Delete`, the response is
1037 # `google.protobuf.Empty`. If the original method is standard
1038 # `Get`/`Create`/`Update`, the response should be the resource. For other
1039 # methods, the response should have the type `XxxResponse`, where `Xxx`
1040 # is the original method name. For example, if the original method name
1041 # is `TakeSnapshot()`, the inferred response type is
1042 # `TakeSnapshotResponse`.
1043 "a_key": "", # Properties of the object. Contains field @type with type URL.
1044 },
1045 "name": "A String", # The server-assigned name, which is only unique within the same service that
1046 # originally returns it. If you use the default HTTP mapping, the
1047 # `name` should be a resource name ending with `operations/{unique_id}`.
1048 }</pre>
1049</div>
1050
1051<div class="method">
1052 <code class="details" id="upgrade">upgrade(name, body=None, x__xgafv=None)</code>
1053 <pre>Upgrades Redis instance to the newer Redis version specified in the
1054request.
1055
1056Args:
1057 name: string, Required. Redis instance resource name using the form:
1058 `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
1059where `location_id` refers to a GCP region. (required)
1060 body: object, The request body.
1061 The object takes the form of:
1062
1063{ # Request for UpgradeInstance.
1064 "redisVersion": "A String", # Required. Specifies the target version of Redis software to upgrade to.
1065 }
1066
1067 x__xgafv: string, V1 error format.
1068 Allowed values
1069 1 - v1 error format
1070 2 - v2 error format
1071
1072Returns:
1073 An object of the form:
1074
1075 { # This resource represents a long-running operation that is the result of a
1076 # network API call.
1077 "metadata": { # {
1078 #
1079 # `createTime`: The time the operation was created.
1080 #
1081 # `endTime`: The time the operation finished running.
1082 #
1083 # `target`: Server-defined resource path for the target of the operation.
1084 #
1085 # `verb`: Name of the verb executed by the operation.
1086 #
1087 # `statusDetail`: Human-readable status of the operation, if any.
1088 #
1089 # `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
1090 #
1091 # `apiVersion`: API version used to start the operation.
1092 #
1093 # }
1094 "a_key": "", # Properties of the object. Contains field @type with type URL.
1095 },
1096 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
1097 # different programming environments, including REST APIs and RPC APIs. It is
1098 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1099 # three pieces of data: error code, error message, and error details.
1100 #
1101 # You can find out more about this error model and how to work with it in the
1102 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1103 "message": "A String", # A developer-facing error message, which should be in English. Any
1104 # user-facing error message should be localized and sent in the
1105 # google.rpc.Status.details field, or localized by the client.
1106 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
1107 "details": [ # A list of messages that carry the error details. There is a common set of
1108 # message types for APIs to use.
1109 {
1110 "a_key": "", # Properties of the object. Contains field @type with type URL.
1111 },
1112 ],
1113 },
1114 "done": True or False, # If the value is `false`, it means the operation is still in progress.
1115 # If `true`, the operation is completed, and either `error` or `response` is
1116 # available.
1117 "response": { # The normal response of the operation in case of success. If the original
1118 # method returns no data on success, such as `Delete`, the response is
1119 # `google.protobuf.Empty`. If the original method is standard
1120 # `Get`/`Create`/`Update`, the response should be the resource. For other
1121 # methods, the response should have the type `XxxResponse`, where `Xxx`
1122 # is the original method name. For example, if the original method name
1123 # is `TakeSnapshot()`, the inferred response type is
1124 # `TakeSnapshotResponse`.
1125 "a_key": "", # Properties of the object. Contains field @type with type URL.
1126 },
1127 "name": "A String", # The server-assigned name, which is only unique within the same service that
1128 # originally returns it. If you use the default HTTP mapping, the
1129 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1130 }</pre>
1131</div>
1132
1133</body></html>