Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f3348f98bf91a88a28bf61b12b95e391cc3be1ff / . / docs / dyn / redis_v1beta1.projects.locations.instances.html
blob: eb5d733d5645e03e2a84a6d65041a60e9568e303 [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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]96 <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]112By default, the instance is accessible from the project&#x27;s
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]131 &quot;authorizedNetwork&quot;: &quot;A String&quot;, # Optional. The full name of the Google Compute Engine
132 # [network](/compute/docs/networks-and-firewalls#networks) to which the
133 # instance is connected. If left unspecified, the `default` network
134 # will be used.
135 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of this instance.
136 &quot;name&quot;: &quot;A String&quot;, # Required. Unique name of the resource in this scope including project and
137 # location using the form:
138 # `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
139 #
140 # Note: Redis instances are managed and addressed at regional level so
141 # location_id here refers to a GCP region; however, users may choose which
142 # specific zone (or collection of zones for cross-zone instances) an instance
143 # should be provisioned in. Refer to location_id and
144 # alternative_location_id fields for more details.
145 &quot;connectMode&quot;: &quot;A String&quot;, # Optional. The network connect mode of the Redis instance.
146 # If not provided, the connect mode defaults to DIRECT_PEERING.
147 &quot;persistenceIamIdentity&quot;: &quot;A String&quot;, # Output only. Cloud IAM identity used by import / export operations to
148 # transfer data to/from Cloud Storage. Format is
149 # &quot;serviceAccount:&lt;service_account_email&gt;&quot;. The value may change over time
150 # for a given instance so should be checked before each import/export
151 # operation.
152 &quot;redisConfigs&quot;: { # Optional. Redis configuration parameters, according to
153 # http://redis.io/topics/config. Currently, the only supported parameters
154 # are:
155 #
156 # Redis version 3.2 and newer:
157 #
158 # * maxmemory-policy
159 # * notify-keyspace-events
160 #
161 # Redis version 4.0 and newer:
162 #
163 # * activedefrag
164 # * lfu-decay-time
165 # * lfu-log-factor
166 # * maxmemory-gb
167 #
168 # Redis version 5.0 and newer:
169 #
170 # * stream-node-max-bytes
171 # * stream-node-max-entries
172 &quot;a_key&quot;: &quot;A String&quot;,
173 },
174 &quot;port&quot;: 42, # Output only. The port number of the exposed Redis endpoint.
175 &quot;host&quot;: &quot;A String&quot;, # Output only. Hostname or IP address of the exposed Redis endpoint used by
176 # clients to connect to the service.
177 &quot;redisVersion&quot;: &quot;A String&quot;, # Optional. The version of Redis software.
178 # If not provided, latest supported version will be used. Currently, the
179 # supported values are:
180 #
181 # * `REDIS_3_2` for Redis 3.2 compatibility
182 # * `REDIS_4_0` for Redis 4.0 compatibility (default)
183 # * `REDIS_5_0` for Redis 5.0 compatibility
184 &quot;tier&quot;: &quot;A String&quot;, # Required. The service tier of the instance.
185 &quot;memorySizeGb&quot;: 42, # Required. Redis memory size in GiB.
186 &quot;displayName&quot;: &quot;A String&quot;, # An arbitrary and optional user-provided name for the instance.
187 &quot;locationId&quot;: &quot;A String&quot;, # Optional. The zone where the instance will be provisioned. If not provided,
188 # the service will choose a zone for the instance. For STANDARD_HA tier,
189 # instances will be created across two zones for protection against zonal
190 # failures. If alternative_location_id is also provided, it must be
191 # different from location_id.
192 &quot;reservedIpRange&quot;: &quot;A String&quot;, # Optional. The CIDR range of internal addresses that are reserved for this
193 # instance. If not provided, the service will choose an unused /29 block,
194 # for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
195 # and non-overlapping with existing subnets in an authorized network.
196 &quot;currentLocationId&quot;: &quot;A String&quot;, # Output only. The current zone where the Redis endpoint is placed. For Basic
197 # Tier instances, this will always be the same as the location_id
198 # provided by the user at creation time. For Standard Tier instances,
199 # this can be either location_id or alternative_location_id and can
200 # change after a failover event.
201 &quot;alternativeLocationId&quot;: &quot;A String&quot;, # Optional. Only applicable to STANDARD_HA tier which protects the instance
202 # against zonal failures by provisioning it across two zones. If provided, it
203 # must be a different zone from the one provided in location_id.
204 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the instance was created.
205 &quot;labels&quot;: { # Resource labels to represent user provided metadata
206 &quot;a_key&quot;: &quot;A String&quot;,
207 },
208 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the current status of this
209 # instance, if available.
210 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]230 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
231 # If `true`, the operation is completed, and either `error` or `response` is
232 # available.
233 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
234 # method returns no data on success, such as `Delete`, the response is
235 # `google.protobuf.Empty`. If the original method is standard
236 # `Get`/`Create`/`Update`, the response should be the resource. For other
237 # methods, the response should have the type `XxxResponse`, where `Xxx`
238 # is the original method name. For example, if the original method name
239 # is `TakeSnapshot()`, the inferred response type is
240 # `TakeSnapshotResponse`.
241 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
242 },
243 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
244 # originally returns it. If you use the default HTTP mapping, the
245 # `name` should be a resource name ending with `operations/{unique_id}`.
246 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
247 # different programming environments, including REST APIs and RPC APIs. It is
248 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
249 # three pieces of data: error code, error message, and error details.
250 #
251 # You can find out more about this error model and how to work with it in the
252 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]253 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]254 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
255 # user-facing error message should be localized and sent in the
256 # google.rpc.Status.details field, or localized by the client.
257 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
258 # message types for APIs to use.
259 {
260 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
261 },
262 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]263 },
264 &quot;metadata&quot;: { # {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]265 #
266 # `createTime`: The time the operation was created.
267 #
268 # `endTime`: The time the operation finished running.
269 #
270 # `target`: Server-defined resource path for the target of the operation.
271 #
272 # `verb`: Name of the verb executed by the operation.
273 #
274 # `statusDetail`: Human-readable status of the operation, if any.
275 #
276 # `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`.
277 #
278 # `apiVersion`: API version used to start the operation.
279 #
280 # }
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]281 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]282 },
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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]305 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
306 # If `true`, the operation is completed, and either `error` or `response` is
307 # available.
308 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
309 # method returns no data on success, such as `Delete`, the response is
310 # `google.protobuf.Empty`. If the original method is standard
311 # `Get`/`Create`/`Update`, the response should be the resource. For other
312 # methods, the response should have the type `XxxResponse`, where `Xxx`
313 # is the original method name. For example, if the original method name
314 # is `TakeSnapshot()`, the inferred response type is
315 # `TakeSnapshotResponse`.
316 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
317 },
318 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
319 # originally returns it. If you use the default HTTP mapping, the
320 # `name` should be a resource name ending with `operations/{unique_id}`.
321 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
322 # different programming environments, including REST APIs and RPC APIs. It is
323 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
324 # three pieces of data: error code, error message, and error details.
325 #
326 # You can find out more about this error model and how to work with it in the
327 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]328 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]329 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
330 # user-facing error message should be localized and sent in the
331 # google.rpc.Status.details field, or localized by the client.
332 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
333 # message types for APIs to use.
334 {
335 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
336 },
337 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]338 },
339 &quot;metadata&quot;: { # {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]340 #
341 # `createTime`: The time the operation was created.
342 #
343 # `endTime`: The time the operation finished running.
344 #
345 # `target`: Server-defined resource path for the target of the operation.
346 #
347 # `verb`: Name of the verb executed by the operation.
348 #
349 # `statusDetail`: Human-readable status of the operation, if any.
350 #
351 # `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`.
352 #
353 # `apiVersion`: API version used to start the operation.
354 #
355 # }
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]356 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]357 },
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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]378 &quot;outputConfig&quot;: { # The output content # Required. Specify data to be exported.
379 &quot;gcsDestination&quot;: { # The Cloud Storage location for the output content # Google Cloud Storage destination for output content.
380 &quot;uri&quot;: &quot;A String&quot;, # Required. Data destination URI (e.g.
381 # &#x27;gs://my_bucket/my_object&#x27;). Existing files will be overwritten.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]396 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
397 # If `true`, the operation is completed, and either `error` or `response` is
398 # available.
399 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
400 # method returns no data on success, such as `Delete`, the response is
401 # `google.protobuf.Empty`. If the original method is standard
402 # `Get`/`Create`/`Update`, the response should be the resource. For other
403 # methods, the response should have the type `XxxResponse`, where `Xxx`
404 # is the original method name. For example, if the original method name
405 # is `TakeSnapshot()`, the inferred response type is
406 # `TakeSnapshotResponse`.
407 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
408 },
409 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
410 # originally returns it. If you use the default HTTP mapping, the
411 # `name` should be a resource name ending with `operations/{unique_id}`.
412 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
413 # different programming environments, including REST APIs and RPC APIs. It is
414 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
415 # three pieces of data: error code, error message, and error details.
416 #
417 # You can find out more about this error model and how to work with it in the
418 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]419 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]420 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
421 # user-facing error message should be localized and sent in the
422 # google.rpc.Status.details field, or localized by the client.
423 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
424 # message types for APIs to use.
425 {
426 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
427 },
428 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]429 },
430 &quot;metadata&quot;: { # {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]431 #
432 # `createTime`: The time the operation was created.
433 #
434 # `endTime`: The time the operation finished running.
435 #
436 # `target`: Server-defined resource path for the target of the operation.
437 #
438 # `verb`: Name of the verb executed by the operation.
439 #
440 # `statusDetail`: Human-readable status of the operation, if any.
441 #
442 # `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`.
443 #
444 # `apiVersion`: API version used to start the operation.
445 #
446 # }
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]447 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]448 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]465 &quot;dataProtectionMode&quot;: &quot;A String&quot;, # Optional. Available data protection modes that the user can choose. If it&#x27;s
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]479 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
480 # If `true`, the operation is completed, and either `error` or `response` is
481 # available.
482 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
483 # method returns no data on success, such as `Delete`, the response is
484 # `google.protobuf.Empty`. If the original method is standard
485 # `Get`/`Create`/`Update`, the response should be the resource. For other
486 # methods, the response should have the type `XxxResponse`, where `Xxx`
487 # is the original method name. For example, if the original method name
488 # is `TakeSnapshot()`, the inferred response type is
489 # `TakeSnapshotResponse`.
490 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
491 },
492 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
493 # originally returns it. If you use the default HTTP mapping, the
494 # `name` should be a resource name ending with `operations/{unique_id}`.
495 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
496 # different programming environments, including REST APIs and RPC APIs. It is
497 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
498 # three pieces of data: error code, error message, and error details.
499 #
500 # You can find out more about this error model and how to work with it in the
501 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]502 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]503 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
504 # user-facing error message should be localized and sent in the
505 # google.rpc.Status.details field, or localized by the client.
506 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
507 # message types for APIs to use.
508 {
509 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
510 },
511 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]512 },
513 &quot;metadata&quot;: { # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]514 #
515 # `createTime`: The time the operation was created.
516 #
517 # `endTime`: The time the operation finished running.
518 #
519 # `target`: Server-defined resource path for the target of the operation.
520 #
521 # `verb`: Name of the verb executed by the operation.
522 #
523 # `statusDetail`: Human-readable status of the operation, if any.
524 #
525 # `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`.
526 #
527 # `apiVersion`: API version used to start the operation.
528 #
529 # }
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]530 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]531 },
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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]552 &quot;authorizedNetwork&quot;: &quot;A String&quot;, # Optional. The full name of the Google Compute Engine
553 # [network](/compute/docs/networks-and-firewalls#networks) to which the
554 # instance is connected. If left unspecified, the `default` network
555 # will be used.
556 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of this instance.
557 &quot;name&quot;: &quot;A String&quot;, # Required. Unique name of the resource in this scope including project and
558 # location using the form:
559 # `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
560 #
561 # Note: Redis instances are managed and addressed at regional level so
562 # location_id here refers to a GCP region; however, users may choose which
563 # specific zone (or collection of zones for cross-zone instances) an instance
564 # should be provisioned in. Refer to location_id and
565 # alternative_location_id fields for more details.
566 &quot;connectMode&quot;: &quot;A String&quot;, # Optional. The network connect mode of the Redis instance.
567 # If not provided, the connect mode defaults to DIRECT_PEERING.
568 &quot;persistenceIamIdentity&quot;: &quot;A String&quot;, # Output only. Cloud IAM identity used by import / export operations to
569 # transfer data to/from Cloud Storage. Format is
570 # &quot;serviceAccount:&lt;service_account_email&gt;&quot;. The value may change over time
571 # for a given instance so should be checked before each import/export
572 # operation.
573 &quot;redisConfigs&quot;: { # Optional. Redis configuration parameters, according to
574 # http://redis.io/topics/config. Currently, the only supported parameters
575 # are:
576 #
577 # Redis version 3.2 and newer:
578 #
579 # * maxmemory-policy
580 # * notify-keyspace-events
581 #
582 # Redis version 4.0 and newer:
583 #
584 # * activedefrag
585 # * lfu-decay-time
586 # * lfu-log-factor
587 # * maxmemory-gb
588 #
589 # Redis version 5.0 and newer:
590 #
591 # * stream-node-max-bytes
592 # * stream-node-max-entries
593 &quot;a_key&quot;: &quot;A String&quot;,
594 },
595 &quot;port&quot;: 42, # Output only. The port number of the exposed Redis endpoint.
596 &quot;host&quot;: &quot;A String&quot;, # Output only. Hostname or IP address of the exposed Redis endpoint used by
597 # clients to connect to the service.
598 &quot;redisVersion&quot;: &quot;A String&quot;, # Optional. The version of Redis software.
599 # If not provided, latest supported version will be used. Currently, the
600 # supported values are:
601 #
602 # * `REDIS_3_2` for Redis 3.2 compatibility
603 # * `REDIS_4_0` for Redis 4.0 compatibility (default)
604 # * `REDIS_5_0` for Redis 5.0 compatibility
605 &quot;tier&quot;: &quot;A String&quot;, # Required. The service tier of the instance.
606 &quot;memorySizeGb&quot;: 42, # Required. Redis memory size in GiB.
607 &quot;displayName&quot;: &quot;A String&quot;, # An arbitrary and optional user-provided name for the instance.
608 &quot;locationId&quot;: &quot;A String&quot;, # Optional. The zone where the instance will be provisioned. If not provided,
609 # the service will choose a zone for the instance. For STANDARD_HA tier,
610 # instances will be created across two zones for protection against zonal
611 # failures. If alternative_location_id is also provided, it must be
612 # different from location_id.
613 &quot;reservedIpRange&quot;: &quot;A String&quot;, # Optional. The CIDR range of internal addresses that are reserved for this
614 # instance. If not provided, the service will choose an unused /29 block,
615 # for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
616 # and non-overlapping with existing subnets in an authorized network.
617 &quot;currentLocationId&quot;: &quot;A String&quot;, # Output only. The current zone where the Redis endpoint is placed. For Basic
618 # Tier instances, this will always be the same as the location_id
619 # provided by the user at creation time. For Standard Tier instances,
620 # this can be either location_id or alternative_location_id and can
621 # change after a failover event.
622 &quot;alternativeLocationId&quot;: &quot;A String&quot;, # Optional. Only applicable to STANDARD_HA tier which protects the instance
623 # against zonal failures by provisioning it across two zones. If provided, it
624 # must be a different zone from the one provided in location_id.
625 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the instance was created.
626 &quot;labels&quot;: { # Resource labels to represent user provided metadata
627 &quot;a_key&quot;: &quot;A String&quot;,
628 },
629 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the current status of this
630 # instance, if available.
631 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]653 &quot;inputConfig&quot;: { # The input content # Required. Specify data to be imported.
654 &quot;gcsSource&quot;: { # The Cloud Storage location for the input content # Google Cloud Storage location where input content is located.
655 &quot;uri&quot;: &quot;A String&quot;, # Required. Source data URI. (e.g. &#x27;gs://my_bucket/my_object&#x27;).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]670 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
671 # If `true`, the operation is completed, and either `error` or `response` is
672 # available.
673 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
674 # method returns no data on success, such as `Delete`, the response is
675 # `google.protobuf.Empty`. If the original method is standard
676 # `Get`/`Create`/`Update`, the response should be the resource. For other
677 # methods, the response should have the type `XxxResponse`, where `Xxx`
678 # is the original method name. For example, if the original method name
679 # is `TakeSnapshot()`, the inferred response type is
680 # `TakeSnapshotResponse`.
681 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
682 },
683 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
684 # originally returns it. If you use the default HTTP mapping, the
685 # `name` should be a resource name ending with `operations/{unique_id}`.
686 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
687 # different programming environments, including REST APIs and RPC APIs. It is
688 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
689 # three pieces of data: error code, error message, and error details.
690 #
691 # You can find out more about this error model and how to work with it in the
692 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]693 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]694 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
695 # user-facing error message should be localized and sent in the
696 # google.rpc.Status.details field, or localized by the client.
697 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
698 # message types for APIs to use.
699 {
700 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
701 },
702 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]703 },
704 &quot;metadata&quot;: { # {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]705 #
706 # `createTime`: The time the operation was created.
707 #
708 # `endTime`: The time the operation finished running.
709 #
710 # `target`: Server-defined resource path for the target of the operation.
711 #
712 # `verb`: Name of the verb executed by the operation.
713 #
714 # `statusDetail`: Human-readable status of the operation, if any.
715 #
716 # `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`.
717 #
718 # `apiVersion`: API version used to start the operation.
719 #
720 # }
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]721 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]722 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]723 }</pre>
724</div>
725
726<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]727 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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 pageSize: integer, The maximum number of items to return.
745
746If not specified, a default value of 1000 will be used by the service.
747Regardless of the page_size value, the response may include a partial list
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]748and a caller should only rely on response&#x27;s
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]749`next_page_token`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]750to determine if there are more instances left to be queried.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]751 x__xgafv: string, V1 error format.
752 Allowed values
753 1 - v1 error format
754 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]755
756Returns:
757 An object of the form:
758
759 { # Response for ListInstances.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]760 &quot;instances&quot;: [ # A list of Redis instances in the project in the specified location,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]761 # or across all locations.
762 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]763 # If the `location_id` in the parent field of the request is &quot;-&quot;, all regions
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]764 # available to the project are queried, and the results aggregated.
765 # If in such an aggregated query a location is unavailable, a dummy Redis
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]766 # entry is included in the response with the `name` field set to a value of
767 # the form `projects/{project_id}/locations/{location_id}/instances/`- and
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]768 # the `status` field set to ERROR and `status_message` field set to &quot;location
769 # not available for ListInstances&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]770 { # A Google Cloud Redis instance.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]771 &quot;authorizedNetwork&quot;: &quot;A String&quot;, # Optional. The full name of the Google Compute Engine
772 # [network](/compute/docs/networks-and-firewalls#networks) to which the
773 # instance is connected. If left unspecified, the `default` network
774 # will be used.
775 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of this instance.
776 &quot;name&quot;: &quot;A String&quot;, # Required. Unique name of the resource in this scope including project and
777 # location using the form:
778 # `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
779 #
780 # Note: Redis instances are managed and addressed at regional level so
781 # location_id here refers to a GCP region; however, users may choose which
782 # specific zone (or collection of zones for cross-zone instances) an instance
783 # should be provisioned in. Refer to location_id and
784 # alternative_location_id fields for more details.
785 &quot;connectMode&quot;: &quot;A String&quot;, # Optional. The network connect mode of the Redis instance.
786 # If not provided, the connect mode defaults to DIRECT_PEERING.
787 &quot;persistenceIamIdentity&quot;: &quot;A String&quot;, # Output only. Cloud IAM identity used by import / export operations to
788 # transfer data to/from Cloud Storage. Format is
789 # &quot;serviceAccount:&lt;service_account_email&gt;&quot;. The value may change over time
790 # for a given instance so should be checked before each import/export
791 # operation.
792 &quot;redisConfigs&quot;: { # Optional. Redis configuration parameters, according to
793 # http://redis.io/topics/config. Currently, the only supported parameters
794 # are:
795 #
796 # Redis version 3.2 and newer:
797 #
798 # * maxmemory-policy
799 # * notify-keyspace-events
800 #
801 # Redis version 4.0 and newer:
802 #
803 # * activedefrag
804 # * lfu-decay-time
805 # * lfu-log-factor
806 # * maxmemory-gb
807 #
808 # Redis version 5.0 and newer:
809 #
810 # * stream-node-max-bytes
811 # * stream-node-max-entries
812 &quot;a_key&quot;: &quot;A String&quot;,
813 },
814 &quot;port&quot;: 42, # Output only. The port number of the exposed Redis endpoint.
815 &quot;host&quot;: &quot;A String&quot;, # Output only. Hostname or IP address of the exposed Redis endpoint used by
816 # clients to connect to the service.
817 &quot;redisVersion&quot;: &quot;A String&quot;, # Optional. The version of Redis software.
818 # If not provided, latest supported version will be used. Currently, the
819 # supported values are:
820 #
821 # * `REDIS_3_2` for Redis 3.2 compatibility
822 # * `REDIS_4_0` for Redis 4.0 compatibility (default)
823 # * `REDIS_5_0` for Redis 5.0 compatibility
824 &quot;tier&quot;: &quot;A String&quot;, # Required. The service tier of the instance.
825 &quot;memorySizeGb&quot;: 42, # Required. Redis memory size in GiB.
826 &quot;displayName&quot;: &quot;A String&quot;, # An arbitrary and optional user-provided name for the instance.
827 &quot;locationId&quot;: &quot;A String&quot;, # Optional. The zone where the instance will be provisioned. If not provided,
828 # the service will choose a zone for the instance. For STANDARD_HA tier,
829 # instances will be created across two zones for protection against zonal
830 # failures. If alternative_location_id is also provided, it must be
831 # different from location_id.
832 &quot;reservedIpRange&quot;: &quot;A String&quot;, # Optional. The CIDR range of internal addresses that are reserved for this
833 # instance. If not provided, the service will choose an unused /29 block,
834 # for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
835 # and non-overlapping with existing subnets in an authorized network.
836 &quot;currentLocationId&quot;: &quot;A String&quot;, # Output only. The current zone where the Redis endpoint is placed. For Basic
837 # Tier instances, this will always be the same as the location_id
838 # provided by the user at creation time. For Standard Tier instances,
839 # this can be either location_id or alternative_location_id and can
840 # change after a failover event.
841 &quot;alternativeLocationId&quot;: &quot;A String&quot;, # Optional. Only applicable to STANDARD_HA tier which protects the instance
842 # against zonal failures by provisioning it across two zones. If provided, it
843 # must be a different zone from the one provided in location_id.
844 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the instance was created.
845 &quot;labels&quot;: { # Resource labels to represent user provided metadata
846 &quot;a_key&quot;: &quot;A String&quot;,
847 },
848 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the current status of this
849 # instance, if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]850 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]851 ],
852 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more
853 # results in the list.
854 &quot;unreachable&quot;: [ # Locations that could not be reached.
855 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]856 ],
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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]869 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]896 &quot;authorizedNetwork&quot;: &quot;A String&quot;, # Optional. The full name of the Google Compute Engine
897 # [network](/compute/docs/networks-and-firewalls#networks) to which the
898 # instance is connected. If left unspecified, the `default` network
899 # will be used.
900 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of this instance.
901 &quot;name&quot;: &quot;A String&quot;, # Required. Unique name of the resource in this scope including project and
902 # location using the form:
903 # `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
904 #
905 # Note: Redis instances are managed and addressed at regional level so
906 # location_id here refers to a GCP region; however, users may choose which
907 # specific zone (or collection of zones for cross-zone instances) an instance
908 # should be provisioned in. Refer to location_id and
909 # alternative_location_id fields for more details.
910 &quot;connectMode&quot;: &quot;A String&quot;, # Optional. The network connect mode of the Redis instance.
911 # If not provided, the connect mode defaults to DIRECT_PEERING.
912 &quot;persistenceIamIdentity&quot;: &quot;A String&quot;, # Output only. Cloud IAM identity used by import / export operations to
913 # transfer data to/from Cloud Storage. Format is
914 # &quot;serviceAccount:&lt;service_account_email&gt;&quot;. The value may change over time
915 # for a given instance so should be checked before each import/export
916 # operation.
917 &quot;redisConfigs&quot;: { # Optional. Redis configuration parameters, according to
918 # http://redis.io/topics/config. Currently, the only supported parameters
919 # are:
920 #
921 # Redis version 3.2 and newer:
922 #
923 # * maxmemory-policy
924 # * notify-keyspace-events
925 #
926 # Redis version 4.0 and newer:
927 #
928 # * activedefrag
929 # * lfu-decay-time
930 # * lfu-log-factor
931 # * maxmemory-gb
932 #
933 # Redis version 5.0 and newer:
934 #
935 # * stream-node-max-bytes
936 # * stream-node-max-entries
937 &quot;a_key&quot;: &quot;A String&quot;,
938 },
939 &quot;port&quot;: 42, # Output only. The port number of the exposed Redis endpoint.
940 &quot;host&quot;: &quot;A String&quot;, # Output only. Hostname or IP address of the exposed Redis endpoint used by
941 # clients to connect to the service.
942 &quot;redisVersion&quot;: &quot;A String&quot;, # Optional. The version of Redis software.
943 # If not provided, latest supported version will be used. Currently, the
944 # supported values are:
945 #
946 # * `REDIS_3_2` for Redis 3.2 compatibility
947 # * `REDIS_4_0` for Redis 4.0 compatibility (default)
948 # * `REDIS_5_0` for Redis 5.0 compatibility
949 &quot;tier&quot;: &quot;A String&quot;, # Required. The service tier of the instance.
950 &quot;memorySizeGb&quot;: 42, # Required. Redis memory size in GiB.
951 &quot;displayName&quot;: &quot;A String&quot;, # An arbitrary and optional user-provided name for the instance.
952 &quot;locationId&quot;: &quot;A String&quot;, # Optional. The zone where the instance will be provisioned. If not provided,
953 # the service will choose a zone for the instance. For STANDARD_HA tier,
954 # instances will be created across two zones for protection against zonal
955 # failures. If alternative_location_id is also provided, it must be
956 # different from location_id.
957 &quot;reservedIpRange&quot;: &quot;A String&quot;, # Optional. The CIDR range of internal addresses that are reserved for this
958 # instance. If not provided, the service will choose an unused /29 block,
959 # for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
960 # and non-overlapping with existing subnets in an authorized network.
961 &quot;currentLocationId&quot;: &quot;A String&quot;, # Output only. The current zone where the Redis endpoint is placed. For Basic
962 # Tier instances, this will always be the same as the location_id
963 # provided by the user at creation time. For Standard Tier instances,
964 # this can be either location_id or alternative_location_id and can
965 # change after a failover event.
966 &quot;alternativeLocationId&quot;: &quot;A String&quot;, # Optional. Only applicable to STANDARD_HA tier which protects the instance
967 # against zonal failures by provisioning it across two zones. If provided, it
968 # must be a different zone from the one provided in location_id.
969 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the instance was created.
970 &quot;labels&quot;: { # Resource labels to represent user provided metadata
971 &quot;a_key&quot;: &quot;A String&quot;,
972 },
973 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the current status of this
974 # instance, if available.
975 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]995 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
996 # If `true`, the operation is completed, and either `error` or `response` is
997 # available.
998 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
999 # method returns no data on success, such as `Delete`, the response is
1000 # `google.protobuf.Empty`. If the original method is standard
1001 # `Get`/`Create`/`Update`, the response should be the resource. For other
1002 # methods, the response should have the type `XxxResponse`, where `Xxx`
1003 # is the original method name. For example, if the original method name
1004 # is `TakeSnapshot()`, the inferred response type is
1005 # `TakeSnapshotResponse`.
1006 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1007 },
1008 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
1009 # originally returns it. If you use the default HTTP mapping, the
1010 # `name` should be a resource name ending with `operations/{unique_id}`.
1011 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
1012 # different programming environments, including REST APIs and RPC APIs. It is
1013 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1014 # three pieces of data: error code, error message, and error details.
1015 #
1016 # You can find out more about this error model and how to work with it in the
1017 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1018 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1019 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1020 # user-facing error message should be localized and sent in the
1021 # google.rpc.Status.details field, or localized by the client.
1022 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1023 # message types for APIs to use.
1024 {
1025 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1026 },
1027 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1028 },
1029 &quot;metadata&quot;: { # {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1030 #
1031 # `createTime`: The time the operation was created.
1032 #
1033 # `endTime`: The time the operation finished running.
1034 #
1035 # `target`: Server-defined resource path for the target of the operation.
1036 #
1037 # `verb`: Name of the verb executed by the operation.
1038 #
1039 # `statusDetail`: Human-readable status of the operation, if any.
1040 #
1041 # `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`.
1042 #
1043 # `apiVersion`: API version used to start the operation.
1044 #
1045 # }
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1046 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1047 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1064 &quot;redisVersion&quot;: &quot;A String&quot;, # Required. Specifies the target version of Redis software to upgrade to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1077 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
1078 # If `true`, the operation is completed, and either `error` or `response` is
1079 # available.
1080 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
1081 # method returns no data on success, such as `Delete`, the response is
1082 # `google.protobuf.Empty`. If the original method is standard
1083 # `Get`/`Create`/`Update`, the response should be the resource. For other
1084 # methods, the response should have the type `XxxResponse`, where `Xxx`
1085 # is the original method name. For example, if the original method name
1086 # is `TakeSnapshot()`, the inferred response type is
1087 # `TakeSnapshotResponse`.
1088 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1089 },
1090 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
1091 # originally returns it. If you use the default HTTP mapping, the
1092 # `name` should be a resource name ending with `operations/{unique_id}`.
1093 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
1094 # different programming environments, including REST APIs and RPC APIs. It is
1095 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1096 # three pieces of data: error code, error message, and error details.
1097 #
1098 # You can find out more about this error model and how to work with it in the
1099 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1100 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1101 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1102 # user-facing error message should be localized and sent in the
1103 # google.rpc.Status.details field, or localized by the client.
1104 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1105 # message types for APIs to use.
1106 {
1107 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1108 },
1109 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1110 },
1111 &quot;metadata&quot;: { # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1112 #
1113 # `createTime`: The time the operation was created.
1114 #
1115 # `endTime`: The time the operation finished running.
1116 #
1117 # `target`: Server-defined resource path for the target of the operation.
1118 #
1119 # `verb`: Name of the verb executed by the operation.
1120 #
1121 # `statusDetail`: Human-readable status of the operation, if any.
1122 #
1123 # `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`.
1124 #
1125 # `apiVersion`: API version used to start the operation.
1126 #
1127 # }
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1128 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1129 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1130 }</pre>
1131</div>
1132
1133</body></html>