blob: 49f0686dc79a171f3b6a93dd797571589c9221f4 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<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="memcache_v1beta2.html">Cloud Memorystore for Memcached API</a> . <a href="memcache_v1beta2.projects.html">projects</a> . <a href="memcache_v1beta2.projects.locations.html">locations</a> . <a href="memcache_v1beta2.projects.locations.instances.html">instances</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#applyParameters">applyParameters(name, body=None, x__xgafv=None)</a></code></p>
yoshi-code-bota8b35b92021-03-31 13:33:30 -070079<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>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070080<p class="toc_element">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -080081 <code><a href="#applySoftwareUpdate">applySoftwareUpdate(instance, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Updates software on the selected nodes of the Instance.</p>
83<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070084 <code><a href="#close">close()</a></code></p>
85<p class="firstline">Close httplib2 connections.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070086<p class="toc_element">
87 <code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088<p class="firstline">Creates a new Instance in a given location.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070089<p class="toc_element">
90 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
91<p class="firstline">Deletes a single Instance.</p>
92<p class="toc_element">
93 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
94<p class="firstline">Gets details of a single Instance.</p>
95<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080096 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097<p class="firstline">Lists Instances in a given location.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070098<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">
102 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
103<p class="firstline">Updates an existing Instance in a given project and location.</p>
104<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700105 <code><a href="#updateParameters">updateParameters(name, body=None, x__xgafv=None)</a></code></p>
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700106<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>
Bu Sun Kim65020912020-05-20 12:08:20 -0700107<h3>Method Details</h3>
108<div class="method">
109 <code class="details" id="applyParameters">applyParameters(name, body=None, x__xgafv=None)</code>
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700110 <pre>`ApplyParameters` restarts the set of specified nodes in order to update them to the current set of parameters for the Memcached Instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700111
112Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700113 name: string, Required. Resource name of the Memcached instance for which parameter group updates should be applied. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700114 body: object, The request body.
115 The object takes the form of:
116
117{ # Request for ApplyParameters.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700118 &quot;applyAll&quot;: 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.
119 &quot;nodeIds&quot;: [ # Nodes to which the instance-level parameter group is applied.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800120 &quot;A String&quot;,
121 ],
122}
Bu Sun Kim65020912020-05-20 12:08:20 -0700123
124 x__xgafv: string, V1 error format.
125 Allowed values
126 1 - v1 error format
127 2 - v2 error format
128
129Returns:
130 An object of the form:
131
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700132 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800133 &quot;done&quot;: 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.
134 &quot;error&quot;: { # 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.
135 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
136 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
137 {
138 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
139 },
140 ],
141 &quot;message&quot;: &quot;A String&quot;, # 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.
142 },
143 &quot;metadata&quot;: { # 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.
144 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
145 },
146 &quot;name&quot;: &quot;A String&quot;, # 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}`.
147 &quot;response&quot;: { # The normal response of the operation in case of success. 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`.
148 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
149 },
150}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700151</div>
152
153<div class="method">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800154 <code class="details" id="applySoftwareUpdate">applySoftwareUpdate(instance, body=None, x__xgafv=None)</code>
155 <pre>Updates software on the selected nodes of the Instance.
156
157Args:
158 instance: string, Required. Resource name of the Memcached instance for which software update should be applied. (required)
159 body: object, The request body.
160 The object takes the form of:
161
162{ # Request for ApplySoftwareUpdate.
163 &quot;applyAll&quot;: True or False, # Whether to apply the update to all nodes. If set to true, will explicitly restrict users from specifying any nodes, and apply software update to all nodes (where applicable) within the instance.
164 &quot;nodeIds&quot;: [ # Nodes to which we should apply the update to. Note all the selected nodes are updated in parallel.
165 &quot;A String&quot;,
166 ],
167}
168
169 x__xgafv: string, V1 error format.
170 Allowed values
171 1 - v1 error format
172 2 - v2 error format
173
174Returns:
175 An object of the form:
176
177 { # This resource represents a long-running operation that is the result of a network API call.
178 &quot;done&quot;: 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.
179 &quot;error&quot;: { # 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.
180 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
181 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
182 {
183 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
184 },
185 ],
186 &quot;message&quot;: &quot;A String&quot;, # 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.
187 },
188 &quot;metadata&quot;: { # 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.
189 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
190 },
191 &quot;name&quot;: &quot;A String&quot;, # 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}`.
192 &quot;response&quot;: { # The normal response of the operation in case of success. 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`.
193 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
194 },
195}</pre>
196</div>
197
198<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700199 <code class="details" id="close">close()</code>
200 <pre>Close httplib2 connections.</pre>
201</div>
202
203<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700204 <code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700205 <pre>Creates a new Instance in a given location.
Bu Sun Kim65020912020-05-20 12:08:20 -0700206
207Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700208 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)
Bu Sun Kim65020912020-05-20 12:08:20 -0700209 body: object, The request body.
210 The object takes the form of:
211
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700212{ # A Memorystore for Memcached instance
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800213 &quot;authorizedNetwork&quot;: &quot;A String&quot;, # The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.
214 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the instance was created.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700215 &quot;discoveryEndpoint&quot;: &quot;A String&quot;, # Output only. Endpoint for the Discovery API.
216 &quot;displayName&quot;: &quot;A String&quot;, # User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
217 &quot;instanceMessages&quot;: [ # List of messages that describe the current state of the Memcached instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800218 {
219 &quot;code&quot;: &quot;A String&quot;, # A code that correspond to one type of user-facing message.
220 &quot;message&quot;: &quot;A String&quot;, # Message on memcached instance which will be exposed to users.
221 },
222 ],
223 &quot;labels&quot;: { # Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
224 &quot;a_key&quot;: &quot;A String&quot;,
225 },
226 &quot;memcacheFullVersion&quot;: &quot;A String&quot;, # 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 &quot;memcached-1.5.16&quot;.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700227 &quot;memcacheNodes&quot;: [ # Output only. List of Memcached nodes. Refer to Node message for more details.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800228 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800229 &quot;host&quot;: &quot;A String&quot;, # Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800230 &quot;nodeId&quot;: &quot;A String&quot;, # Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700231 &quot;parameters&quot;: { # 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. # User defined parameters currently applied to the node.
232 &quot;id&quot;: &quot;A String&quot;, # Output only.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800233 &quot;params&quot;: { # User defined set of parameters to use in the memcached process.
234 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700235 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700236 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800237 &quot;port&quot;: 42, # Output only. The port number of the Memcached server on this node.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800238 &quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the Memcached node.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800239 &quot;updateAvailable&quot;: True or False, # Output only. Returns true if there is an update waiting to be applied
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800240 &quot;zone&quot;: &quot;A String&quot;, # Output only. Location (GCP Zone) for the Memcached node.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800241 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800242 ],
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700243 &quot;memcacheVersion&quot;: &quot;A String&quot;, # 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.
244 &quot;name&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800245 &quot;nodeConfig&quot;: { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
246 &quot;cpuCount&quot;: 42, # Required. Number of cpus per Memcached node.
247 &quot;memorySizeMb&quot;: 42, # Required. Memory size in MiB for each Memcached node.
248 },
249 &quot;nodeCount&quot;: 42, # Required. Number of nodes in the Memcached instance.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700250 &quot;parameters&quot;: { # 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. # Optional: User defined parameters to apply to the memcached process on each node.
251 &quot;id&quot;: &quot;A String&quot;, # Output only.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800252 &quot;params&quot;: { # User defined set of parameters to use in the memcached process.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800253 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700254 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800255 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800256 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this Memcached instance.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800257 &quot;updateAvailable&quot;: True or False, # Output only. Returns true if there is an update waiting to be applied
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800258 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the instance was updated.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700259 &quot;zones&quot;: [ # 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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800260 &quot;A String&quot;,
261 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800262}
Bu Sun Kim65020912020-05-20 12:08:20 -0700263
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700264 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700265 x__xgafv: string, V1 error format.
266 Allowed values
267 1 - v1 error format
268 2 - v2 error format
269
270Returns:
271 An object of the form:
272
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700273 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800274 &quot;done&quot;: 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.
275 &quot;error&quot;: { # 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.
276 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
277 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
278 {
279 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
280 },
281 ],
282 &quot;message&quot;: &quot;A String&quot;, # 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.
283 },
284 &quot;metadata&quot;: { # 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.
285 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
286 },
287 &quot;name&quot;: &quot;A String&quot;, # 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}`.
288 &quot;response&quot;: { # The normal response of the operation in case of success. 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`.
289 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
290 },
291}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700292</div>
293
294<div class="method">
295 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
296 <pre>Deletes a single Instance.
297
298Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700299 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)
Bu Sun Kim65020912020-05-20 12:08:20 -0700300 x__xgafv: string, V1 error format.
301 Allowed values
302 1 - v1 error format
303 2 - v2 error format
304
305Returns:
306 An object of the form:
307
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700308 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800309 &quot;done&quot;: 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.
310 &quot;error&quot;: { # 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.
311 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
312 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
313 {
314 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
315 },
316 ],
317 &quot;message&quot;: &quot;A String&quot;, # 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.
318 },
319 &quot;metadata&quot;: { # 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.
320 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
321 },
322 &quot;name&quot;: &quot;A String&quot;, # 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}`.
323 &quot;response&quot;: { # The normal response of the operation in case of success. 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`.
324 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
325 },
326}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700327</div>
328
329<div class="method">
330 <code class="details" id="get">get(name, x__xgafv=None)</code>
331 <pre>Gets details of a single Instance.
332
333Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700334 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)
Bu Sun Kim65020912020-05-20 12:08:20 -0700335 x__xgafv: string, V1 error format.
336 Allowed values
337 1 - v1 error format
338 2 - v2 error format
339
340Returns:
341 An object of the form:
342
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700343 { # A Memorystore for Memcached instance
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800344 &quot;authorizedNetwork&quot;: &quot;A String&quot;, # The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.
345 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the instance was created.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700346 &quot;discoveryEndpoint&quot;: &quot;A String&quot;, # Output only. Endpoint for the Discovery API.
347 &quot;displayName&quot;: &quot;A String&quot;, # User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
348 &quot;instanceMessages&quot;: [ # List of messages that describe the current state of the Memcached instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800349 {
350 &quot;code&quot;: &quot;A String&quot;, # A code that correspond to one type of user-facing message.
351 &quot;message&quot;: &quot;A String&quot;, # Message on memcached instance which will be exposed to users.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800352 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800353 ],
354 &quot;labels&quot;: { # Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
355 &quot;a_key&quot;: &quot;A String&quot;,
356 },
357 &quot;memcacheFullVersion&quot;: &quot;A String&quot;, # 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 &quot;memcached-1.5.16&quot;.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700358 &quot;memcacheNodes&quot;: [ # Output only. List of Memcached nodes. Refer to Node message for more details.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800359 {
360 &quot;host&quot;: &quot;A String&quot;, # Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
361 &quot;nodeId&quot;: &quot;A String&quot;, # Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700362 &quot;parameters&quot;: { # 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. # User defined parameters currently applied to the node.
363 &quot;id&quot;: &quot;A String&quot;, # Output only.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800364 &quot;params&quot;: { # User defined set of parameters to use in the memcached process.
365 &quot;a_key&quot;: &quot;A String&quot;,
366 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800367 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800368 &quot;port&quot;: 42, # Output only. The port number of the Memcached server on this node.
369 &quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the Memcached node.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800370 &quot;updateAvailable&quot;: True or False, # Output only. Returns true if there is an update waiting to be applied
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800371 &quot;zone&quot;: &quot;A String&quot;, # Output only. Location (GCP Zone) for the Memcached node.
372 },
373 ],
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700374 &quot;memcacheVersion&quot;: &quot;A String&quot;, # 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.
375 &quot;name&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800376 &quot;nodeConfig&quot;: { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
377 &quot;cpuCount&quot;: 42, # Required. Number of cpus per Memcached node.
378 &quot;memorySizeMb&quot;: 42, # Required. Memory size in MiB for each Memcached node.
379 },
380 &quot;nodeCount&quot;: 42, # Required. Number of nodes in the Memcached instance.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700381 &quot;parameters&quot;: { # 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. # Optional: User defined parameters to apply to the memcached process on each node.
382 &quot;id&quot;: &quot;A String&quot;, # Output only.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800383 &quot;params&quot;: { # User defined set of parameters to use in the memcached process.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800384 &quot;a_key&quot;: &quot;A String&quot;,
385 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800386 },
387 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this Memcached instance.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800388 &quot;updateAvailable&quot;: True or False, # Output only. Returns true if there is an update waiting to be applied
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800389 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the instance was updated.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700390 &quot;zones&quot;: [ # 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800391 &quot;A String&quot;,
392 ],
393}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700394</div>
395
396<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800397 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700398 <pre>Lists Instances in a given location.
Bu Sun Kim65020912020-05-20 12:08:20 -0700399
400Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700401 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)
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700402 filter: string, List filter. For example, exclude all Memcached instances with name as my-instance by specifying `&quot;name != my-instance&quot;`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800403 orderBy: string, Sort results. Supported values are &quot;name&quot;, &quot;name desc&quot; or &quot;&quot; (unsorted).
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700404 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&#x27;s `next_page_token` to determine if there are more instances left to be queried.
405 pageToken: string, The `next_page_token` value returned from a previous List request, if any.
Bu Sun Kim65020912020-05-20 12:08:20 -0700406 x__xgafv: string, V1 error format.
407 Allowed values
408 1 - v1 error format
409 2 - v2 error format
410
411Returns:
412 An object of the form:
413
414 { # Response for ListInstances.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800415 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
416 &quot;resources&quot;: [ # 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 &quot;-&quot;, all regions available to the project are queried, and the results aggregated.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700417 { # A Memorystore for Memcached instance
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800418 &quot;authorizedNetwork&quot;: &quot;A String&quot;, # The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.
419 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the instance was created.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700420 &quot;discoveryEndpoint&quot;: &quot;A String&quot;, # Output only. Endpoint for the Discovery API.
421 &quot;displayName&quot;: &quot;A String&quot;, # User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
422 &quot;instanceMessages&quot;: [ # List of messages that describe the current state of the Memcached instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800423 {
424 &quot;code&quot;: &quot;A String&quot;, # A code that correspond to one type of user-facing message.
425 &quot;message&quot;: &quot;A String&quot;, # Message on memcached instance which will be exposed to users.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800426 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800427 ],
428 &quot;labels&quot;: { # Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
429 &quot;a_key&quot;: &quot;A String&quot;,
430 },
431 &quot;memcacheFullVersion&quot;: &quot;A String&quot;, # 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 &quot;memcached-1.5.16&quot;.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700432 &quot;memcacheNodes&quot;: [ # Output only. List of Memcached nodes. Refer to Node message for more details.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800433 {
434 &quot;host&quot;: &quot;A String&quot;, # Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
435 &quot;nodeId&quot;: &quot;A String&quot;, # Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700436 &quot;parameters&quot;: { # 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. # User defined parameters currently applied to the node.
437 &quot;id&quot;: &quot;A String&quot;, # Output only.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800438 &quot;params&quot;: { # User defined set of parameters to use in the memcached process.
439 &quot;a_key&quot;: &quot;A String&quot;,
440 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800441 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800442 &quot;port&quot;: 42, # Output only. The port number of the Memcached server on this node.
443 &quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the Memcached node.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800444 &quot;updateAvailable&quot;: True or False, # Output only. Returns true if there is an update waiting to be applied
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800445 &quot;zone&quot;: &quot;A String&quot;, # Output only. Location (GCP Zone) for the Memcached node.
446 },
447 ],
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700448 &quot;memcacheVersion&quot;: &quot;A String&quot;, # 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.
449 &quot;name&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800450 &quot;nodeConfig&quot;: { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
451 &quot;cpuCount&quot;: 42, # Required. Number of cpus per Memcached node.
452 &quot;memorySizeMb&quot;: 42, # Required. Memory size in MiB for each Memcached node.
453 },
454 &quot;nodeCount&quot;: 42, # Required. Number of nodes in the Memcached instance.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700455 &quot;parameters&quot;: { # 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. # Optional: User defined parameters to apply to the memcached process on each node.
456 &quot;id&quot;: &quot;A String&quot;, # Output only.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800457 &quot;params&quot;: { # User defined set of parameters to use in the memcached process.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800458 &quot;a_key&quot;: &quot;A String&quot;,
459 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800460 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800461 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this Memcached instance.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800462 &quot;updateAvailable&quot;: True or False, # Output only. Returns true if there is an update waiting to be applied
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800463 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the instance was updated.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700464 &quot;zones&quot;: [ # 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800465 &quot;A String&quot;,
466 ],
467 },
468 ],
469 &quot;unreachable&quot;: [ # Locations that could not be reached.
470 &quot;A String&quot;,
471 ],
472}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700473</div>
474
475<div class="method">
476 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
477 <pre>Retrieves the next page of results.
478
479Args:
480 previous_request: The request for the previous page. (required)
481 previous_response: The response from the request for the previous page. (required)
482
483Returns:
484 A request object that you can call &#x27;execute()&#x27; on to request the next
485 page. Returns None if there are no more items in the collection.
486 </pre>
487</div>
488
489<div class="method">
490 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
491 <pre>Updates an existing Instance in a given project and location.
492
493Args:
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700494 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)
Bu Sun Kim65020912020-05-20 12:08:20 -0700495 body: object, The request body.
496 The object takes the form of:
497
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700498{ # A Memorystore for Memcached instance
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800499 &quot;authorizedNetwork&quot;: &quot;A String&quot;, # The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.
500 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the instance was created.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700501 &quot;discoveryEndpoint&quot;: &quot;A String&quot;, # Output only. Endpoint for the Discovery API.
502 &quot;displayName&quot;: &quot;A String&quot;, # User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
503 &quot;instanceMessages&quot;: [ # List of messages that describe the current state of the Memcached instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800504 {
505 &quot;code&quot;: &quot;A String&quot;, # A code that correspond to one type of user-facing message.
506 &quot;message&quot;: &quot;A String&quot;, # Message on memcached instance which will be exposed to users.
507 },
508 ],
509 &quot;labels&quot;: { # Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
510 &quot;a_key&quot;: &quot;A String&quot;,
511 },
512 &quot;memcacheFullVersion&quot;: &quot;A String&quot;, # 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 &quot;memcached-1.5.16&quot;.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700513 &quot;memcacheNodes&quot;: [ # Output only. List of Memcached nodes. Refer to Node message for more details.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800514 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800515 &quot;host&quot;: &quot;A String&quot;, # Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800516 &quot;nodeId&quot;: &quot;A String&quot;, # Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700517 &quot;parameters&quot;: { # 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. # User defined parameters currently applied to the node.
518 &quot;id&quot;: &quot;A String&quot;, # Output only.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800519 &quot;params&quot;: { # User defined set of parameters to use in the memcached process.
520 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700521 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700522 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800523 &quot;port&quot;: 42, # Output only. The port number of the Memcached server on this node.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800524 &quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the Memcached node.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800525 &quot;updateAvailable&quot;: True or False, # Output only. Returns true if there is an update waiting to be applied
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800526 &quot;zone&quot;: &quot;A String&quot;, # Output only. Location (GCP Zone) for the Memcached node.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800527 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800528 ],
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700529 &quot;memcacheVersion&quot;: &quot;A String&quot;, # 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.
530 &quot;name&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800531 &quot;nodeConfig&quot;: { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
532 &quot;cpuCount&quot;: 42, # Required. Number of cpus per Memcached node.
533 &quot;memorySizeMb&quot;: 42, # Required. Memory size in MiB for each Memcached node.
534 },
535 &quot;nodeCount&quot;: 42, # Required. Number of nodes in the Memcached instance.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700536 &quot;parameters&quot;: { # 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. # Optional: User defined parameters to apply to the memcached process on each node.
537 &quot;id&quot;: &quot;A String&quot;, # Output only.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800538 &quot;params&quot;: { # User defined set of parameters to use in the memcached process.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800539 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700540 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800541 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800542 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this Memcached instance.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800543 &quot;updateAvailable&quot;: True or False, # Output only. Returns true if there is an update waiting to be applied
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800544 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the instance was updated.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700545 &quot;zones&quot;: [ # 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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800546 &quot;A String&quot;,
547 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800548}
Bu Sun Kim65020912020-05-20 12:08:20 -0700549
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700550 updateMask: string, Required. Mask of fields to update. * `displayName`
Bu Sun Kim65020912020-05-20 12:08:20 -0700551 x__xgafv: string, V1 error format.
552 Allowed values
553 1 - v1 error format
554 2 - v2 error format
555
556Returns:
557 An object of the form:
558
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700559 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800560 &quot;done&quot;: 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.
561 &quot;error&quot;: { # 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.
562 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
563 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
564 {
565 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
566 },
567 ],
568 &quot;message&quot;: &quot;A String&quot;, # 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.
569 },
570 &quot;metadata&quot;: { # 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.
571 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
572 },
573 &quot;name&quot;: &quot;A String&quot;, # 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}`.
574 &quot;response&quot;: { # The normal response of the operation in case of success. 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`.
575 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
576 },
577}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700578</div>
579
580<div class="method">
581 <code class="details" id="updateParameters">updateParameters(name, body=None, x__xgafv=None)</code>
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700582 <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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700583
584Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700585 name: string, Required. Resource name of the Memcached instance for which the parameters should be updated. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700586 body: object, The request body.
587 The object takes the form of:
588
589{ # Request for UpdateParameters.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700590 &quot;parameters&quot;: { # 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. # The parameters to apply to the instance.
591 &quot;id&quot;: &quot;A String&quot;, # Output only.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800592 &quot;params&quot;: { # User defined set of parameters to use in the memcached process.
593 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700594 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800595 },
596 &quot;updateMask&quot;: &quot;A String&quot;, # Required. Mask of fields to update.
597}
Bu Sun Kim65020912020-05-20 12:08:20 -0700598
599 x__xgafv: string, V1 error format.
600 Allowed values
601 1 - v1 error format
602 2 - v2 error format
603
604Returns:
605 An object of the form:
606
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700607 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800608 &quot;done&quot;: 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.
609 &quot;error&quot;: { # 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.
610 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
611 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
612 {
613 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
614 },
615 ],
616 &quot;message&quot;: &quot;A String&quot;, # 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.
617 },
618 &quot;metadata&quot;: { # 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.
619 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
620 },
621 &quot;name&quot;: &quot;A String&quot;, # 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}`.
622 &quot;response&quot;: { # The normal response of the operation in case of success. 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`.
623 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
624 },
625}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700626</div>
627
628</body></html>