1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="memcache_v1.html">Cloud Memorystore for Memcached API</a> . <a href="memcache_v1.projects.html">projects</a> . <a href="memcache_v1.projects.locations.html">locations</a> . <a href="memcache_v1.projects.locations.instances.html">instances</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#applyParameters">applyParameters(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">`ApplyParameters` restarts the set of specified nodes in order to update them to the current set of parameters for the Memcached Instance.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new Instance in a given location.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single Instance.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single Instance.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Instances in a given location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing Instance in a given project and location.</p>
<p class="toc_element">
<code><a href="#rescheduleMaintenance">rescheduleMaintenance(instance, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Reschedules upcoming maintenance event.</p>
<p class="toc_element">
<code><a href="#updateParameters">updateParameters(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the defined Memcached parameters for an existing instance. This method only stages the parameters, it must be followed by `ApplyParameters` to apply the parameters to nodes of the Memcached instance.</p>
<p class="toc_element">
<code><a href="#upgrade">upgrade(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Upgrades the Memcache instance to a newer memcached engine version specified in the request.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="applyParameters">applyParameters(name, body=None, x__xgafv=None)</code>
<pre>`ApplyParameters` restarts the set of specified nodes in order to update them to the current set of parameters for the Memcached Instance.
Args:
name: string, Required. Resource name of the Memcached instance for which parameter group updates should be applied. (required)
body: object, The request body.
The object takes the form of:
{ # Request for ApplyParameters.
"applyAll": True or False, # Whether to apply instance-level parameter group to all nodes. If set to true, users are restricted from specifying individual nodes, and `ApplyParameters` updates all nodes within the instance.
"nodeIds": [ # Nodes to which the instance-level parameter group is applied.
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>
<pre>Creates a new Instance in a given location.
Args:
parent: string, Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region (required)
body: object, The request body.
The object takes the form of:
{ # A Memorystore for Memcached instance
"authorizedNetwork": "A String", # The full name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. If left unspecified, the `default` network will be used.
"createTime": "A String", # Output only. The time the instance was created.
"discoveryEndpoint": "A String", # Output only. Endpoint for the Discovery API.
"displayName": "A String", # User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
"instanceMessages": [ # List of messages that describe the current state of the Memcached instance.
{
"code": "A String", # A code that correspond to one type of user-facing message.
"message": "A String", # Message on memcached instance which will be exposed to users.
},
],
"labels": { # Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
"a_key": "A String",
},
"maintenancePolicy": { # Maintenance policy per instance. # The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.
"createTime": "A String", # Output only. The time when the policy was created.
"description": "A String", # Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
"updateTime": "A String", # Output only. The time when the policy was updated.
"weeklyMaintenanceWindow": [ # Required. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_windows is expected to be one.
{ # Time window specified for weekly operations.
"day": "A String", # Required. Allows to define schedule that runs specified day of the week.
"duration": "A String", # Required. Duration of the time window.
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Start time of the window in UTC.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
},
"maintenanceSchedule": { # Upcoming maintenance schedule. # Output only. Published maintenance schedule.
"endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance.
"scheduleDeadlineTime": "A String", # Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.
"startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance.
},
"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
"memcacheNodes": [ # Output only. List of Memcached nodes. Refer to Node message for more details.
{
"host": "A String", # Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this node. e.g. - memcached-1.5.16
"memcacheVersion": "A String", # Output only. Major version of memcached server running on this node, e.g. MEMCACHE_1_5
"nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
"parameters": { # User defined parameters currently applied to the node.
"id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes. A discrepancy between parameter ids can inform users that they may need to take action to apply parameters on nodes.
"params": { # User defined set of parameters to use in the memcached process.
"a_key": "A String",
},
},
"port": 42, # Output only. The port number of the Memcached server on this node.
"state": "A String", # Output only. Current state of the Memcached node.
"zone": "A String", # Output only. Location (GCP Zone) for the Memcached node.
},
],
"memcacheVersion": "A String", # The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is `MEMCACHE_1_5`. The minor version will be automatically determined by our system based on the latest supported minor version.
"name": "A String", # Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Memcached instances are managed and addressed at the regional level so `location_id` here refers to a Google Cloud region; however, users may choose which zones Memcached nodes should be provisioned in within an instance. Refer to zones field for more details.
"nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
"cpuCount": 42, # Required. Number of cpus per Memcached node.
"memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node.
},
"nodeCount": 42, # Required. Number of nodes in the Memcached instance.
"parameters": { # User defined parameters to apply to the memcached process on each node.
"id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes. A discrepancy between parameter ids can inform users that they may need to take action to apply parameters on nodes.
"params": { # User defined set of parameters to use in the memcached process.
"a_key": "A String",
},
},
"reservedIpRangeId": [ # Optional. Contains the id of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29.
"A String",
],
"satisfiesPzi": True or False, # Optional. Output only. Reserved for future use.
"satisfiesPzs": True or False, # Optional. Output only. Reserved for future use.
"state": "A String", # Output only. The state of this Memcached instance.
"updateTime": "A String", # Output only. The time the instance was updated.
"zones": [ # Zones in which Memcached nodes should be provisioned. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.
"A String",
],
}
instanceId: string, Required. The logical name of the Memcached instance in the user project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the user project / location. If any of the above are not met, the API raises an invalid argument error.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a single Instance.
Args:
name: string, Required. Memcached instance resource name in the format: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single Instance.
Args:
name: string, Required. Memcached instance resource name in the format: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A Memorystore for Memcached instance
"authorizedNetwork": "A String", # The full name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. If left unspecified, the `default` network will be used.
"createTime": "A String", # Output only. The time the instance was created.
"discoveryEndpoint": "A String", # Output only. Endpoint for the Discovery API.
"displayName": "A String", # User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
"instanceMessages": [ # List of messages that describe the current state of the Memcached instance.
{
"code": "A String", # A code that correspond to one type of user-facing message.
"message": "A String", # Message on memcached instance which will be exposed to users.
},
],
"labels": { # Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
"a_key": "A String",
},
"maintenancePolicy": { # Maintenance policy per instance. # The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.
"createTime": "A String", # Output only. The time when the policy was created.
"description": "A String", # Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
"updateTime": "A String", # Output only. The time when the policy was updated.
"weeklyMaintenanceWindow": [ # Required. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_windows is expected to be one.
{ # Time window specified for weekly operations.
"day": "A String", # Required. Allows to define schedule that runs specified day of the week.
"duration": "A String", # Required. Duration of the time window.
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Start time of the window in UTC.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
},
"maintenanceSchedule": { # Upcoming maintenance schedule. # Output only. Published maintenance schedule.
"endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance.
"scheduleDeadlineTime": "A String", # Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.
"startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance.
},
"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
"memcacheNodes": [ # Output only. List of Memcached nodes. Refer to Node message for more details.
{
"host": "A String", # Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this node. e.g. - memcached-1.5.16
"memcacheVersion": "A String", # Output only. Major version of memcached server running on this node, e.g. MEMCACHE_1_5
"nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
"parameters": { # User defined parameters currently applied to the node.
"id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes. A discrepancy between parameter ids can inform users that they may need to take action to apply parameters on nodes.
"params": { # User defined set of parameters to use in the memcached process.
"a_key": "A String",
},
},
"port": 42, # Output only. The port number of the Memcached server on this node.
"state": "A String", # Output only. Current state of the Memcached node.
"zone": "A String", # Output only. Location (GCP Zone) for the Memcached node.
},
],
"memcacheVersion": "A String", # The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is `MEMCACHE_1_5`. The minor version will be automatically determined by our system based on the latest supported minor version.
"name": "A String", # Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Memcached instances are managed and addressed at the regional level so `location_id` here refers to a Google Cloud region; however, users may choose which zones Memcached nodes should be provisioned in within an instance. Refer to zones field for more details.
"nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
"cpuCount": 42, # Required. Number of cpus per Memcached node.
"memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node.
},
"nodeCount": 42, # Required. Number of nodes in the Memcached instance.
"parameters": { # User defined parameters to apply to the memcached process on each node.
"id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes. A discrepancy between parameter ids can inform users that they may need to take action to apply parameters on nodes.
"params": { # User defined set of parameters to use in the memcached process.
"a_key": "A String",
},
},
"reservedIpRangeId": [ # Optional. Contains the id of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29.
"A String",
],
"satisfiesPzi": True or False, # Optional. Output only. Reserved for future use.
"satisfiesPzs": True or False, # Optional. Output only. Reserved for future use.
"state": "A String", # Output only. The state of this Memcached instance.
"updateTime": "A String", # Output only. The time the instance was updated.
"zones": [ # Zones in which Memcached nodes should be provisioned. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Instances in a given location.
Args:
parent: string, Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region (required)
filter: string, List filter. For example, exclude all Memcached instances with name as my-instance by specifying `"name != my-instance"`.
orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
pageSize: integer, The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the `page_size` value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more instances left to be queried.
pageToken: string, The `next_page_token` value returned from a previous List request, if any.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for ListInstances.
"instances": [ # A list of Memcached instances in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated.
{ # A Memorystore for Memcached instance
"authorizedNetwork": "A String", # The full name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. If left unspecified, the `default` network will be used.
"createTime": "A String", # Output only. The time the instance was created.
"discoveryEndpoint": "A String", # Output only. Endpoint for the Discovery API.
"displayName": "A String", # User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
"instanceMessages": [ # List of messages that describe the current state of the Memcached instance.
{
"code": "A String", # A code that correspond to one type of user-facing message.
"message": "A String", # Message on memcached instance which will be exposed to users.
},
],
"labels": { # Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
"a_key": "A String",
},
"maintenancePolicy": { # Maintenance policy per instance. # The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.
"createTime": "A String", # Output only. The time when the policy was created.
"description": "A String", # Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
"updateTime": "A String", # Output only. The time when the policy was updated.
"weeklyMaintenanceWindow": [ # Required. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_windows is expected to be one.
{ # Time window specified for weekly operations.
"day": "A String", # Required. Allows to define schedule that runs specified day of the week.
"duration": "A String", # Required. Duration of the time window.
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Start time of the window in UTC.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
},
"maintenanceSchedule": { # Upcoming maintenance schedule. # Output only. Published maintenance schedule.
"endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance.
"scheduleDeadlineTime": "A String", # Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.
"startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance.
},
"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
"memcacheNodes": [ # Output only. List of Memcached nodes. Refer to Node message for more details.
{
"host": "A String", # Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this node. e.g. - memcached-1.5.16
"memcacheVersion": "A String", # Output only. Major version of memcached server running on this node, e.g. MEMCACHE_1_5
"nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
"parameters": { # User defined parameters currently applied to the node.
"id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes. A discrepancy between parameter ids can inform users that they may need to take action to apply parameters on nodes.
"params": { # User defined set of parameters to use in the memcached process.
"a_key": "A String",
},
},
"port": 42, # Output only. The port number of the Memcached server on this node.
"state": "A String", # Output only. Current state of the Memcached node.
"zone": "A String", # Output only. Location (GCP Zone) for the Memcached node.
},
],
"memcacheVersion": "A String", # The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is `MEMCACHE_1_5`. The minor version will be automatically determined by our system based on the latest supported minor version.
"name": "A String", # Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Memcached instances are managed and addressed at the regional level so `location_id` here refers to a Google Cloud region; however, users may choose which zones Memcached nodes should be provisioned in within an instance. Refer to zones field for more details.
"nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
"cpuCount": 42, # Required. Number of cpus per Memcached node.
"memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node.
},
"nodeCount": 42, # Required. Number of nodes in the Memcached instance.
"parameters": { # User defined parameters to apply to the memcached process on each node.
"id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes. A discrepancy between parameter ids can inform users that they may need to take action to apply parameters on nodes.
"params": { # User defined set of parameters to use in the memcached process.
"a_key": "A String",
},
},
"reservedIpRangeId": [ # Optional. Contains the id of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29.
"A String",
],
"satisfiesPzi": True or False, # Optional. Output only. Reserved for future use.
"satisfiesPzs": True or False, # Optional. Output only. Reserved for future use.
"state": "A String", # Output only. The state of this Memcached instance.
"updateTime": "A String", # Output only. The time the instance was updated.
"zones": [ # Zones in which Memcached nodes should be provisioned. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.
"A String",
],
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
"unreachable": [ # Locations that could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an existing Instance in a given project and location.
Args:
name: string, Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Memcached instances are managed and addressed at the regional level so `location_id` here refers to a Google Cloud region; however, users may choose which zones Memcached nodes should be provisioned in within an instance. Refer to zones field for more details. (required)
body: object, The request body.
The object takes the form of:
{ # A Memorystore for Memcached instance
"authorizedNetwork": "A String", # The full name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. If left unspecified, the `default` network will be used.
"createTime": "A String", # Output only. The time the instance was created.
"discoveryEndpoint": "A String", # Output only. Endpoint for the Discovery API.
"displayName": "A String", # User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
"instanceMessages": [ # List of messages that describe the current state of the Memcached instance.
{
"code": "A String", # A code that correspond to one type of user-facing message.
"message": "A String", # Message on memcached instance which will be exposed to users.
},
],
"labels": { # Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
"a_key": "A String",
},
"maintenancePolicy": { # Maintenance policy per instance. # The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.
"createTime": "A String", # Output only. The time when the policy was created.
"description": "A String", # Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
"updateTime": "A String", # Output only. The time when the policy was updated.
"weeklyMaintenanceWindow": [ # Required. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_windows is expected to be one.
{ # Time window specified for weekly operations.
"day": "A String", # Required. Allows to define schedule that runs specified day of the week.
"duration": "A String", # Required. Duration of the time window.
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Start time of the window in UTC.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
},
"maintenanceSchedule": { # Upcoming maintenance schedule. # Output only. Published maintenance schedule.
"endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance.
"scheduleDeadlineTime": "A String", # Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.
"startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance.
},
"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
"memcacheNodes": [ # Output only. List of Memcached nodes. Refer to Node message for more details.
{
"host": "A String", # Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this node. e.g. - memcached-1.5.16
"memcacheVersion": "A String", # Output only. Major version of memcached server running on this node, e.g. MEMCACHE_1_5
"nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
"parameters": { # User defined parameters currently applied to the node.
"id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes. A discrepancy between parameter ids can inform users that they may need to take action to apply parameters on nodes.
"params": { # User defined set of parameters to use in the memcached process.
"a_key": "A String",
},
},
"port": 42, # Output only. The port number of the Memcached server on this node.
"state": "A String", # Output only. Current state of the Memcached node.
"zone": "A String", # Output only. Location (GCP Zone) for the Memcached node.
},
],
"memcacheVersion": "A String", # The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is `MEMCACHE_1_5`. The minor version will be automatically determined by our system based on the latest supported minor version.
"name": "A String", # Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Memcached instances are managed and addressed at the regional level so `location_id` here refers to a Google Cloud region; however, users may choose which zones Memcached nodes should be provisioned in within an instance. Refer to zones field for more details.
"nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
"cpuCount": 42, # Required. Number of cpus per Memcached node.
"memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node.
},
"nodeCount": 42, # Required. Number of nodes in the Memcached instance.
"parameters": { # User defined parameters to apply to the memcached process on each node.
"id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes. A discrepancy between parameter ids can inform users that they may need to take action to apply parameters on nodes.
"params": { # User defined set of parameters to use in the memcached process.
"a_key": "A String",
},
},
"reservedIpRangeId": [ # Optional. Contains the id of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29.
"A String",
],
"satisfiesPzi": True or False, # Optional. Output only. Reserved for future use.
"satisfiesPzs": True or False, # Optional. Output only. Reserved for future use.
"state": "A String", # Output only. The state of this Memcached instance.
"updateTime": "A String", # Output only. The time the instance was updated.
"zones": [ # Zones in which Memcached nodes should be provisioned. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.
"A String",
],
}
updateMask: string, Required. Mask of fields to update. * `displayName`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="rescheduleMaintenance">rescheduleMaintenance(instance, body=None, x__xgafv=None)</code>
<pre>Reschedules upcoming maintenance event.
Args:
instance: string, Required. Memcache instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. (required)
body: object, The request body.
The object takes the form of:
{ # Request for RescheduleMaintenance.
"rescheduleType": "A String", # Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.
"scheduleTime": "A String", # Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example `2012-11-15T16:19:00.094Z`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="updateParameters">updateParameters(name, body=None, x__xgafv=None)</code>
<pre>Updates the defined Memcached parameters for an existing instance. This method only stages the parameters, it must be followed by `ApplyParameters` to apply the parameters to nodes of the Memcached instance.
Args:
name: string, Required. Resource name of the Memcached instance for which the parameters should be updated. (required)
body: object, The request body.
The object takes the form of:
{ # Request for UpdateParameters.
"parameters": { # The parameters to apply to the instance.
"id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes. A discrepancy between parameter ids can inform users that they may need to take action to apply parameters on nodes.
"params": { # User defined set of parameters to use in the memcached process.
"a_key": "A String",
},
},
"updateMask": "A String", # Required. Mask of fields to update.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="upgrade">upgrade(name, body=None, x__xgafv=None)</code>
<pre>Upgrades the Memcache instance to a newer memcached engine version specified in the request.
Args:
name: string, Required. Memcache instance resource name using the form: `projects/{project}/locations/{location}/instances/{instance}` where `location_id` refers to a GCP region. (required)
body: object, The request body.
The object takes the form of:
{ # Request for UpgradeInstance.
"memcacheVersion": "A String", # Required. Specifies the target version of memcached engine to upgrade to.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>
|
