blob: 52e7ad2ecca0a32c78b3f94a1d8ca113490507a8 [file] [log] [blame]
yoshi-code-botb6dc1b92021-03-02 11:49:08 -08001<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_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>
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>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -080080<p class="toc_element">
81 <code><a href="#close">close()</a></code></p>
82<p class="firstline">Close httplib2 connections.</p>
83<p class="toc_element">
84 <code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Creates a new Instance in a given location.</p>
86<p class="toc_element">
87 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Deletes a single Instance.</p>
89<p class="toc_element">
90 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
91<p class="firstline">Gets details of a single Instance.</p>
92<p class="toc_element">
93 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Lists Instances in a given location.</p>
95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
99 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
100<p class="firstline">Updates an existing Instance in a given project and location.</p>
101<p class="toc_element">
102 <code><a href="#updateParameters">updateParameters(name, body=None, x__xgafv=None)</a></code></p>
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700103<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>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800104<h3>Method Details</h3>
105<div class="method">
106 <code class="details" id="applyParameters">applyParameters(name, body=None, x__xgafv=None)</code>
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700107 <pre>`ApplyParameters` restarts the set of specified nodes in order to update them to the current set of parameters for the Memcached Instance.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800108
109Args:
110 name: string, Required. Resource name of the Memcached instance for which parameter group updates should be applied. (required)
111 body: object, The request body.
112 The object takes the form of:
113
114{ # Request for ApplyParameters.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700115 &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.
116 &quot;nodeIds&quot;: [ # Nodes to which the instance-level parameter group is applied.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800117 &quot;A String&quot;,
118 ],
119}
120
121 x__xgafv: string, V1 error format.
122 Allowed values
123 1 - v1 error format
124 2 - v2 error format
125
126Returns:
127 An object of the form:
128
129 { # This resource represents a long-running operation that is the result of a network API call.
130 &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.
131 &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.
132 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
133 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
134 {
135 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
136 },
137 ],
138 &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.
139 },
140 &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.
141 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
142 },
143 &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}`.
144 &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`.
145 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
146 },
147}</pre>
148</div>
149
150<div class="method">
151 <code class="details" id="close">close()</code>
152 <pre>Close httplib2 connections.</pre>
153</div>
154
155<div class="method">
156 <code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>
157 <pre>Creates a new Instance in a given location.
158
159Args:
160 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)
161 body: object, The request body.
162 The object takes the form of:
163
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700164{ # A Memorystore for Memcached instance
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800165 &quot;authorizedNetwork&quot;: &quot;A String&quot;, # 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.
166 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the instance was created.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700167 &quot;discoveryEndpoint&quot;: &quot;A String&quot;, # Output only. Endpoint for the Discovery API.
168 &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.
169 &quot;instanceMessages&quot;: [ # List of messages that describe the current state of the Memcached instance.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800170 {
171 &quot;code&quot;: &quot;A String&quot;, # A code that correspond to one type of user-facing message.
172 &quot;message&quot;: &quot;A String&quot;, # Message on memcached instance which will be exposed to users.
173 },
174 ],
175 &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
176 &quot;a_key&quot;: &quot;A String&quot;,
177 },
178 &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 -0700179 &quot;memcacheNodes&quot;: [ # Output only. List of Memcached nodes. Refer to Node message for more details.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800180 {
181 &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.
182 &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 -0700183 &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.
184 &quot;id&quot;: &quot;A String&quot;, # Output only.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800185 &quot;params&quot;: { # User defined set of parameters to use in the memcached process.
186 &quot;a_key&quot;: &quot;A String&quot;,
187 },
188 },
189 &quot;port&quot;: 42, # Output only. The port number of the Memcached server on this node.
190 &quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the Memcached node.
191 &quot;zone&quot;: &quot;A String&quot;, # Output only. Location (GCP Zone) for the Memcached node.
192 },
193 ],
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700194 &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.
195 &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-code-botb6dc1b92021-03-02 11:49:08 -0800196 &quot;nodeConfig&quot;: { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
197 &quot;cpuCount&quot;: 42, # Required. Number of cpus per Memcached node.
198 &quot;memorySizeMb&quot;: 42, # Required. Memory size in MiB for each Memcached node.
199 },
200 &quot;nodeCount&quot;: 42, # Required. Number of nodes in the Memcached instance.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700201 &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.
202 &quot;id&quot;: &quot;A String&quot;, # Output only.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800203 &quot;params&quot;: { # User defined set of parameters to use in the memcached process.
204 &quot;a_key&quot;: &quot;A String&quot;,
205 },
206 },
207 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this Memcached instance.
208 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the instance was updated.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700209 &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-code-botb6dc1b92021-03-02 11:49:08 -0800210 &quot;A String&quot;,
211 ],
212}
213
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700214 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.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800215 x__xgafv: string, V1 error format.
216 Allowed values
217 1 - v1 error format
218 2 - v2 error format
219
220Returns:
221 An object of the form:
222
223 { # This resource represents a long-running operation that is the result of a network API call.
224 &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.
225 &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.
226 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
227 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
228 {
229 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
230 },
231 ],
232 &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.
233 },
234 &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.
235 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
236 },
237 &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}`.
238 &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`.
239 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
240 },
241}</pre>
242</div>
243
244<div class="method">
245 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
246 <pre>Deletes a single Instance.
247
248Args:
249 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)
250 x__xgafv: string, V1 error format.
251 Allowed values
252 1 - v1 error format
253 2 - v2 error format
254
255Returns:
256 An object of the form:
257
258 { # This resource represents a long-running operation that is the result of a network API call.
259 &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.
260 &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.
261 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
262 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
263 {
264 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
265 },
266 ],
267 &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.
268 },
269 &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.
270 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
271 },
272 &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}`.
273 &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`.
274 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
275 },
276}</pre>
277</div>
278
279<div class="method">
280 <code class="details" id="get">get(name, x__xgafv=None)</code>
281 <pre>Gets details of a single Instance.
282
283Args:
284 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)
285 x__xgafv: string, V1 error format.
286 Allowed values
287 1 - v1 error format
288 2 - v2 error format
289
290Returns:
291 An object of the form:
292
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700293 { # A Memorystore for Memcached instance
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800294 &quot;authorizedNetwork&quot;: &quot;A String&quot;, # 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.
295 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the instance was created.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700296 &quot;discoveryEndpoint&quot;: &quot;A String&quot;, # Output only. Endpoint for the Discovery API.
297 &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.
298 &quot;instanceMessages&quot;: [ # List of messages that describe the current state of the Memcached instance.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800299 {
300 &quot;code&quot;: &quot;A String&quot;, # A code that correspond to one type of user-facing message.
301 &quot;message&quot;: &quot;A String&quot;, # Message on memcached instance which will be exposed to users.
302 },
303 ],
304 &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
305 &quot;a_key&quot;: &quot;A String&quot;,
306 },
307 &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 -0700308 &quot;memcacheNodes&quot;: [ # Output only. List of Memcached nodes. Refer to Node message for more details.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800309 {
310 &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.
311 &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 -0700312 &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.
313 &quot;id&quot;: &quot;A String&quot;, # Output only.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800314 &quot;params&quot;: { # User defined set of parameters to use in the memcached process.
315 &quot;a_key&quot;: &quot;A String&quot;,
316 },
317 },
318 &quot;port&quot;: 42, # Output only. The port number of the Memcached server on this node.
319 &quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the Memcached node.
320 &quot;zone&quot;: &quot;A String&quot;, # Output only. Location (GCP Zone) for the Memcached node.
321 },
322 ],
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700323 &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.
324 &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-code-botb6dc1b92021-03-02 11:49:08 -0800325 &quot;nodeConfig&quot;: { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
326 &quot;cpuCount&quot;: 42, # Required. Number of cpus per Memcached node.
327 &quot;memorySizeMb&quot;: 42, # Required. Memory size in MiB for each Memcached node.
328 },
329 &quot;nodeCount&quot;: 42, # Required. Number of nodes in the Memcached instance.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700330 &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.
331 &quot;id&quot;: &quot;A String&quot;, # Output only.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800332 &quot;params&quot;: { # User defined set of parameters to use in the memcached process.
333 &quot;a_key&quot;: &quot;A String&quot;,
334 },
335 },
336 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this Memcached instance.
337 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the instance was updated.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700338 &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-code-botb6dc1b92021-03-02 11:49:08 -0800339 &quot;A String&quot;,
340 ],
341}</pre>
342</div>
343
344<div class="method">
345 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
346 <pre>Lists Instances in a given location.
347
348Args:
349 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 -0700350 filter: string, List filter. For example, exclude all Memcached instances with name as my-instance by specifying `&quot;name != my-instance&quot;`.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800351 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 -0700352 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.
353 pageToken: string, The `next_page_token` value returned from a previous List request, if any.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800354 x__xgafv: string, V1 error format.
355 Allowed values
356 1 - v1 error format
357 2 - v2 error format
358
359Returns:
360 An object of the form:
361
362 { # Response for ListInstances.
363 &quot;instances&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 -0700364 { # A Memorystore for Memcached instance
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800365 &quot;authorizedNetwork&quot;: &quot;A String&quot;, # 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.
366 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the instance was created.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700367 &quot;discoveryEndpoint&quot;: &quot;A String&quot;, # Output only. Endpoint for the Discovery API.
368 &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.
369 &quot;instanceMessages&quot;: [ # List of messages that describe the current state of the Memcached instance.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800370 {
371 &quot;code&quot;: &quot;A String&quot;, # A code that correspond to one type of user-facing message.
372 &quot;message&quot;: &quot;A String&quot;, # Message on memcached instance which will be exposed to users.
373 },
374 ],
375 &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
376 &quot;a_key&quot;: &quot;A String&quot;,
377 },
378 &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 -0700379 &quot;memcacheNodes&quot;: [ # Output only. List of Memcached nodes. Refer to Node message for more details.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800380 {
381 &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.
382 &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 -0700383 &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.
384 &quot;id&quot;: &quot;A String&quot;, # Output only.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800385 &quot;params&quot;: { # User defined set of parameters to use in the memcached process.
386 &quot;a_key&quot;: &quot;A String&quot;,
387 },
388 },
389 &quot;port&quot;: 42, # Output only. The port number of the Memcached server on this node.
390 &quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the Memcached node.
391 &quot;zone&quot;: &quot;A String&quot;, # Output only. Location (GCP Zone) for the Memcached node.
392 },
393 ],
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700394 &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.
395 &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-code-botb6dc1b92021-03-02 11:49:08 -0800396 &quot;nodeConfig&quot;: { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
397 &quot;cpuCount&quot;: 42, # Required. Number of cpus per Memcached node.
398 &quot;memorySizeMb&quot;: 42, # Required. Memory size in MiB for each Memcached node.
399 },
400 &quot;nodeCount&quot;: 42, # Required. Number of nodes in the Memcached instance.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700401 &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.
402 &quot;id&quot;: &quot;A String&quot;, # Output only.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800403 &quot;params&quot;: { # User defined set of parameters to use in the memcached process.
404 &quot;a_key&quot;: &quot;A String&quot;,
405 },
406 },
407 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this Memcached instance.
408 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the instance was updated.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700409 &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-code-botb6dc1b92021-03-02 11:49:08 -0800410 &quot;A String&quot;,
411 ],
412 },
413 ],
414 &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.
415 &quot;unreachable&quot;: [ # Locations that could not be reached.
416 &quot;A String&quot;,
417 ],
418}</pre>
419</div>
420
421<div class="method">
422 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
423 <pre>Retrieves the next page of results.
424
425Args:
426 previous_request: The request for the previous page. (required)
427 previous_response: The response from the request for the previous page. (required)
428
429Returns:
430 A request object that you can call &#x27;execute()&#x27; on to request the next
431 page. Returns None if there are no more items in the collection.
432 </pre>
433</div>
434
435<div class="method">
436 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
437 <pre>Updates an existing Instance in a given project and location.
438
439Args:
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700440 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)
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800441 body: object, The request body.
442 The object takes the form of:
443
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700444{ # A Memorystore for Memcached instance
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800445 &quot;authorizedNetwork&quot;: &quot;A String&quot;, # 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.
446 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the instance was created.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700447 &quot;discoveryEndpoint&quot;: &quot;A String&quot;, # Output only. Endpoint for the Discovery API.
448 &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.
449 &quot;instanceMessages&quot;: [ # List of messages that describe the current state of the Memcached instance.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800450 {
451 &quot;code&quot;: &quot;A String&quot;, # A code that correspond to one type of user-facing message.
452 &quot;message&quot;: &quot;A String&quot;, # Message on memcached instance which will be exposed to users.
453 },
454 ],
455 &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
456 &quot;a_key&quot;: &quot;A String&quot;,
457 },
458 &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 -0700459 &quot;memcacheNodes&quot;: [ # Output only. List of Memcached nodes. Refer to Node message for more details.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800460 {
461 &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.
462 &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 -0700463 &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.
464 &quot;id&quot;: &quot;A String&quot;, # Output only.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800465 &quot;params&quot;: { # User defined set of parameters to use in the memcached process.
466 &quot;a_key&quot;: &quot;A String&quot;,
467 },
468 },
469 &quot;port&quot;: 42, # Output only. The port number of the Memcached server on this node.
470 &quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the Memcached node.
471 &quot;zone&quot;: &quot;A String&quot;, # Output only. Location (GCP Zone) for the Memcached node.
472 },
473 ],
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700474 &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.
475 &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-code-botb6dc1b92021-03-02 11:49:08 -0800476 &quot;nodeConfig&quot;: { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
477 &quot;cpuCount&quot;: 42, # Required. Number of cpus per Memcached node.
478 &quot;memorySizeMb&quot;: 42, # Required. Memory size in MiB for each Memcached node.
479 },
480 &quot;nodeCount&quot;: 42, # Required. Number of nodes in the Memcached instance.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700481 &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.
482 &quot;id&quot;: &quot;A String&quot;, # Output only.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800483 &quot;params&quot;: { # User defined set of parameters to use in the memcached process.
484 &quot;a_key&quot;: &quot;A String&quot;,
485 },
486 },
487 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of this Memcached instance.
488 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the instance was updated.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700489 &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-code-botb6dc1b92021-03-02 11:49:08 -0800490 &quot;A String&quot;,
491 ],
492}
493
494 updateMask: string, Required. Mask of fields to update. * `displayName`
495 x__xgafv: string, V1 error format.
496 Allowed values
497 1 - v1 error format
498 2 - v2 error format
499
500Returns:
501 An object of the form:
502
503 { # This resource represents a long-running operation that is the result of a network API call.
504 &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.
505 &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.
506 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
507 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
508 {
509 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
510 },
511 ],
512 &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.
513 },
514 &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.
515 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
516 },
517 &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}`.
518 &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`.
519 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
520 },
521}</pre>
522</div>
523
524<div class="method">
525 <code class="details" id="updateParameters">updateParameters(name, body=None, x__xgafv=None)</code>
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700526 <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.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800527
528Args:
529 name: string, Required. Resource name of the Memcached instance for which the parameters should be updated. (required)
530 body: object, The request body.
531 The object takes the form of:
532
533{ # Request for UpdateParameters.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700534 &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.
535 &quot;id&quot;: &quot;A String&quot;, # Output only.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800536 &quot;params&quot;: { # User defined set of parameters to use in the memcached process.
537 &quot;a_key&quot;: &quot;A String&quot;,
538 },
539 },
540 &quot;updateMask&quot;: &quot;A String&quot;, # Required. Mask of fields to update.
541}
542
543 x__xgafv: string, V1 error format.
544 Allowed values
545 1 - v1 error format
546 2 - v2 error format
547
548Returns:
549 An object of the form:
550
551 { # This resource represents a long-running operation that is the result of a network API call.
552 &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.
553 &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.
554 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
555 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
556 {
557 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
558 },
559 ],
560 &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.
561 },
562 &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.
563 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
564 },
565 &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}`.
566 &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`.
567 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
568 },
569}</pre>
570</div>
571
572</body></html>