Blame - docs/dyn/memcache_v1beta2.projects.locations.instances.html - platform/external/python/google-api-python-client

blob: 49f0686dc79a171f3b6a93dd797571589c9221f4 [file] [log] [blame]

Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, 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
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, 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-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	79	<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 Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	80	<p class="toc_element">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	81	<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 Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	84	<code><a href="#close">close()</a></code></p>
				85	<p class="firstline">Close httplib2 connections.</p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	86	<p class="toc_element">
				87	<code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	88	<p class="firstline">Creates a new Instance in a given location.</p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	89	<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 Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	96	<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	97	<p class="firstline">Lists Instances in a given location.</p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	98	<p class="toc_element">
				99	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				100	<p class="firstline">Retrieves the next page of results.</p>
				101	<p class="toc_element">
				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 Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	105	<code><a href="#updateParameters">updateParameters(name, body=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	106	<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 Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	107	<h3>Method Details</h3>
				108	<div class="method">
				109	<code class="details" id="applyParameters">applyParameters(name, body=None, x__xgafv=None)</code>
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	110	<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 Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	111
				112	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	113	name: string, Required. Resource name of the Memcached instance for which parameter group updates should be applied. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	114	body: object, The request body.
				115	The object takes the form of:
				116
				117	{ # Request for ApplyParameters.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	118	"applyAll": True or False, # Whether to apply instance-level parameter group to all nodes. If set to true, users are restricted from specifying individual nodes, and `ApplyParameters` updates all nodes within the instance.
				119	"nodeIds": [ # Nodes to which the instance-level parameter group is applied.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	120	"A String",
				121	],
				122	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	123
				124	x__xgafv: string, V1 error format.
				125	Allowed values
				126	1 - v1 error format
				127	2 - v2 error format
				128
				129	Returns:
				130	An object of the form:
				131
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	132	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	133	"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
				134	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
				135	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				136	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				137	{
				138	"a_key": "", # Properties of the object. Contains field @type with type URL.
				139	},
				140	],
				141	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
				142	},
				143	"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
				144	"a_key": "", # Properties of the object. Contains field @type with type URL.
				145	},
				146	"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
				147	"response": { # 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	"a_key": "", # Properties of the object. Contains field @type with type URL.
				149	},
				150	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	151	</div>
				152
				153	<div class="method">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	154	<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
				157	Args:
				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	"applyAll": 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	"nodeIds": [ # Nodes to which we should apply the update to. Note all the selected nodes are updated in parallel.
				165	"A String",
				166	],
				167	}
				168
				169	x__xgafv: string, V1 error format.
				170	Allowed values
				171	1 - v1 error format
				172	2 - v2 error format
				173
				174	Returns:
				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	"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
				179	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
				180	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				181	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				182	{
				183	"a_key": "", # Properties of the object. Contains field @type with type URL.
				184	},
				185	],
				186	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
				187	},
				188	"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
				189	"a_key": "", # Properties of the object. Contains field @type with type URL.
				190	},
				191	"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
				192	"response": { # 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	"a_key": "", # Properties of the object. Contains field @type with type URL.
				194	},
				195	}</pre>
				196	</div>
				197
				198	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	199	<code class="details" id="close">close()</code>
				200	<pre>Close httplib2 connections.</pre>
				201	</div>
				202
				203	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	204	<code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	205	<pre>Creates a new Instance in a given location.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	206
				207	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	208	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 Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	209	body: object, The request body.
				210	The object takes the form of:
				211
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	212	{ # A Memorystore for Memcached instance
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	213	"authorizedNetwork": "A String", # 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	"createTime": "A String", # Output only. The time the instance was created.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	215	"discoveryEndpoint": "A String", # Output only. Endpoint for the Discovery API.
				216	"displayName": "A String", # User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
				217	"instanceMessages": [ # List of messages that describe the current state of the Memcached instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	218	{
				219	"code": "A String", # A code that correspond to one type of user-facing message.
				220	"message": "A String", # Message on memcached instance which will be exposed to users.
				221	},
				222	],
				223	"labels": { # Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
				224	"a_key": "A String",
				225	},
				226	"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	227	"memcacheNodes": [ # Output only. List of Memcached nodes. Refer to Node message for more details.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	228	{
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	229	"host": "A String", # Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	230	"nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	231	"parameters": { # 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	"id": "A String", # Output only.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	233	"params": { # User defined set of parameters to use in the memcached process.
				234	"a_key": "A String",
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	235	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	236	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	237	"port": 42, # Output only. The port number of the Memcached server on this node.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	238	"state": "A String", # Output only. Current state of the Memcached node.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	239	"updateAvailable": True or False, # Output only. Returns true if there is an update waiting to be applied
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	240	"zone": "A String", # Output only. Location (GCP Zone) for the Memcached node.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	241	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	242	],
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	243	"memcacheVersion": "A String", # The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is `MEMCACHE_1_5`. The minor version will be automatically determined by our system based on the latest supported minor version.
				244	"name": "A String", # Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Memcached instances are managed and addressed at the regional level so `location_id` here refers to a Google Cloud region; however, users may choose which zones Memcached nodes should be provisioned in within an instance. Refer to zones field for more details.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	245	"nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
				246	"cpuCount": 42, # Required. Number of cpus per Memcached node.
				247	"memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node.
				248	},
				249	"nodeCount": 42, # Required. Number of nodes in the Memcached instance.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	250	"parameters": { # 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	"id": "A String", # Output only.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	252	"params": { # User defined set of parameters to use in the memcached process.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	253	"a_key": "A String",
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	254	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	255	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	256	"state": "A String", # Output only. The state of this Memcached instance.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	257	"updateAvailable": True or False, # Output only. Returns true if there is an update waiting to be applied
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	258	"updateTime": "A String", # Output only. The time the instance was updated.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	259	"zones": [ # Zones in which Memcached nodes should be provisioned. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	260	"A String",
				261	],
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	262	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	263
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	264	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 Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	265	x__xgafv: string, V1 error format.
				266	Allowed values
				267	1 - v1 error format
				268	2 - v2 error format
				269
				270	Returns:
				271	An object of the form:
				272
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	273	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	274	"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
				275	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
				276	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				277	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				278	{
				279	"a_key": "", # Properties of the object. Contains field @type with type URL.
				280	},
				281	],
				282	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
				283	},
				284	"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
				285	"a_key": "", # Properties of the object. Contains field @type with type URL.
				286	},
				287	"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
				288	"response": { # 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	"a_key": "", # Properties of the object. Contains field @type with type URL.
				290	},
				291	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	292	</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
				298	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	299	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 Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	300	x__xgafv: string, V1 error format.
				301	Allowed values
				302	1 - v1 error format
				303	2 - v2 error format
				304
				305	Returns:
				306	An object of the form:
				307
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	308	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	309	"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
				310	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
				311	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				312	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				313	{
				314	"a_key": "", # Properties of the object. Contains field @type with type URL.
				315	},
				316	],
				317	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
				318	},
				319	"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
				320	"a_key": "", # Properties of the object. Contains field @type with type URL.
				321	},
				322	"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
				323	"response": { # 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	"a_key": "", # Properties of the object. Contains field @type with type URL.
				325	},
				326	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	327	</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
				333	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	334	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 Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	335	x__xgafv: string, V1 error format.
				336	Allowed values
				337	1 - v1 error format
				338	2 - v2 error format
				339
				340	Returns:
				341	An object of the form:
				342
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	343	{ # A Memorystore for Memcached instance
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	344	"authorizedNetwork": "A String", # 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	"createTime": "A String", # Output only. The time the instance was created.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	346	"discoveryEndpoint": "A String", # Output only. Endpoint for the Discovery API.
				347	"displayName": "A String", # User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
				348	"instanceMessages": [ # List of messages that describe the current state of the Memcached instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	349	{
				350	"code": "A String", # A code that correspond to one type of user-facing message.
				351	"message": "A String", # Message on memcached instance which will be exposed to users.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	352	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	353	],
				354	"labels": { # Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
				355	"a_key": "A String",
				356	},
				357	"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	358	"memcacheNodes": [ # Output only. List of Memcached nodes. Refer to Node message for more details.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	359	{
				360	"host": "A String", # Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
				361	"nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	362	"parameters": { # 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	"id": "A String", # Output only.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	364	"params": { # User defined set of parameters to use in the memcached process.
				365	"a_key": "A String",
				366	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	367	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	368	"port": 42, # Output only. The port number of the Memcached server on this node.
				369	"state": "A String", # Output only. Current state of the Memcached node.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	370	"updateAvailable": True or False, # Output only. Returns true if there is an update waiting to be applied
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	371	"zone": "A String", # Output only. Location (GCP Zone) for the Memcached node.
				372	},
				373	],
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	374	"memcacheVersion": "A String", # The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is `MEMCACHE_1_5`. The minor version will be automatically determined by our system based on the latest supported minor version.
				375	"name": "A String", # Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Memcached instances are managed and addressed at the regional level so `location_id` here refers to a Google Cloud region; however, users may choose which zones Memcached nodes should be provisioned in within an instance. Refer to zones field for more details.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	376	"nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
				377	"cpuCount": 42, # Required. Number of cpus per Memcached node.
				378	"memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node.
				379	},
				380	"nodeCount": 42, # Required. Number of nodes in the Memcached instance.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	381	"parameters": { # 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	"id": "A String", # Output only.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	383	"params": { # User defined set of parameters to use in the memcached process.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	384	"a_key": "A String",
				385	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	386	},
				387	"state": "A String", # Output only. The state of this Memcached instance.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	388	"updateAvailable": True or False, # Output only. Returns true if there is an update waiting to be applied
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	389	"updateTime": "A String", # Output only. The time the instance was updated.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	390	"zones": [ # Zones in which Memcached nodes should be provisioned. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	391	"A String",
				392	],
				393	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	394	</div>
				395
				396	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	397	<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	398	<pre>Lists Instances in a given location.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	399
				400	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	401	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-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	402	filter: string, List filter. For example, exclude all Memcached instances with name as my-instance by specifying `"name != my-instance"`.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	403	orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	404	pageSize: integer, The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the `page_size` value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more instances left to be queried.
				405	pageToken: string, The `next_page_token` value returned from a previous List request, if any.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	406	x__xgafv: string, V1 error format.
				407	Allowed values
				408	1 - v1 error format
				409	2 - v2 error format
				410
				411	Returns:
				412	An object of the form:
				413
				414	{ # Response for ListInstances.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	415	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
				416	"resources": [ # A list of Memcached instances in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	417	{ # A Memorystore for Memcached instance
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	418	"authorizedNetwork": "A String", # 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	"createTime": "A String", # Output only. The time the instance was created.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	420	"discoveryEndpoint": "A String", # Output only. Endpoint for the Discovery API.
				421	"displayName": "A String", # User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
				422	"instanceMessages": [ # List of messages that describe the current state of the Memcached instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	423	{
				424	"code": "A String", # A code that correspond to one type of user-facing message.
				425	"message": "A String", # Message on memcached instance which will be exposed to users.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	426	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	427	],
				428	"labels": { # Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
				429	"a_key": "A String",
				430	},
				431	"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	432	"memcacheNodes": [ # Output only. List of Memcached nodes. Refer to Node message for more details.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	433	{
				434	"host": "A String", # Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
				435	"nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	436	"parameters": { # 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	"id": "A String", # Output only.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	438	"params": { # User defined set of parameters to use in the memcached process.
				439	"a_key": "A String",
				440	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	441	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	442	"port": 42, # Output only. The port number of the Memcached server on this node.
				443	"state": "A String", # Output only. Current state of the Memcached node.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	444	"updateAvailable": True or False, # Output only. Returns true if there is an update waiting to be applied
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	445	"zone": "A String", # Output only. Location (GCP Zone) for the Memcached node.
				446	},
				447	],
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	448	"memcacheVersion": "A String", # The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is `MEMCACHE_1_5`. The minor version will be automatically determined by our system based on the latest supported minor version.
				449	"name": "A String", # Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Memcached instances are managed and addressed at the regional level so `location_id` here refers to a Google Cloud region; however, users may choose which zones Memcached nodes should be provisioned in within an instance. Refer to zones field for more details.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	450	"nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
				451	"cpuCount": 42, # Required. Number of cpus per Memcached node.
				452	"memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node.
				453	},
				454	"nodeCount": 42, # Required. Number of nodes in the Memcached instance.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	455	"parameters": { # 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	"id": "A String", # Output only.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	457	"params": { # User defined set of parameters to use in the memcached process.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	458	"a_key": "A String",
				459	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	460	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	461	"state": "A String", # Output only. The state of this Memcached instance.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	462	"updateAvailable": True or False, # Output only. Returns true if there is an update waiting to be applied
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	463	"updateTime": "A String", # Output only. The time the instance was updated.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	464	"zones": [ # Zones in which Memcached nodes should be provisioned. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	465	"A String",
				466	],
				467	},
				468	],
				469	"unreachable": [ # Locations that could not be reached.
				470	"A String",
				471	],
				472	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	473	</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
				479	Args:
				480	previous_request: The request for the previous page. (required)
				481	previous_response: The response from the request for the previous page. (required)
				482
				483	Returns:
				484	A request object that you can call 'execute()' 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
				493	Args:
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	494	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 Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	495	body: object, The request body.
				496	The object takes the form of:
				497
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	498	{ # A Memorystore for Memcached instance
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	499	"authorizedNetwork": "A String", # 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	"createTime": "A String", # Output only. The time the instance was created.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	501	"discoveryEndpoint": "A String", # Output only. Endpoint for the Discovery API.
				502	"displayName": "A String", # User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
				503	"instanceMessages": [ # List of messages that describe the current state of the Memcached instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	504	{
				505	"code": "A String", # A code that correspond to one type of user-facing message.
				506	"message": "A String", # Message on memcached instance which will be exposed to users.
				507	},
				508	],
				509	"labels": { # Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
				510	"a_key": "A String",
				511	},
				512	"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	513	"memcacheNodes": [ # Output only. List of Memcached nodes. Refer to Node message for more details.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	514	{
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	515	"host": "A String", # Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	516	"nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	517	"parameters": { # 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	"id": "A String", # Output only.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	519	"params": { # User defined set of parameters to use in the memcached process.
				520	"a_key": "A String",
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	521	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	522	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	523	"port": 42, # Output only. The port number of the Memcached server on this node.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	524	"state": "A String", # Output only. Current state of the Memcached node.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	525	"updateAvailable": True or False, # Output only. Returns true if there is an update waiting to be applied
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	526	"zone": "A String", # Output only. Location (GCP Zone) for the Memcached node.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	527	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	528	],
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	529	"memcacheVersion": "A String", # The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is `MEMCACHE_1_5`. The minor version will be automatically determined by our system based on the latest supported minor version.
				530	"name": "A String", # Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Memcached instances are managed and addressed at the regional level so `location_id` here refers to a Google Cloud region; however, users may choose which zones Memcached nodes should be provisioned in within an instance. Refer to zones field for more details.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	531	"nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
				532	"cpuCount": 42, # Required. Number of cpus per Memcached node.
				533	"memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node.
				534	},
				535	"nodeCount": 42, # Required. Number of nodes in the Memcached instance.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	536	"parameters": { # 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	"id": "A String", # Output only.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	538	"params": { # User defined set of parameters to use in the memcached process.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	539	"a_key": "A String",
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	540	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	541	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	542	"state": "A String", # Output only. The state of this Memcached instance.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	543	"updateAvailable": True or False, # Output only. Returns true if there is an update waiting to be applied
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	544	"updateTime": "A String", # Output only. The time the instance was updated.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	545	"zones": [ # Zones in which Memcached nodes should be provisioned. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	546	"A String",
				547	],
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	548	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	549
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	550	updateMask: string, Required. Mask of fields to update. * `displayName`
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	551	x__xgafv: string, V1 error format.
				552	Allowed values
				553	1 - v1 error format
				554	2 - v2 error format
				555
				556	Returns:
				557	An object of the form:
				558
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	559	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	560	"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
				561	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
				562	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				563	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				564	{
				565	"a_key": "", # Properties of the object. Contains field @type with type URL.
				566	},
				567	],
				568	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
				569	},
				570	"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
				571	"a_key": "", # Properties of the object. Contains field @type with type URL.
				572	},
				573	"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
				574	"response": { # 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	"a_key": "", # Properties of the object. Contains field @type with type URL.
				576	},
				577	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	578	</div>
				579
				580	<div class="method">
				581	<code class="details" id="updateParameters">updateParameters(name, body=None, x__xgafv=None)</code>
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	582	<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 Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	583
				584	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	585	name: string, Required. Resource name of the Memcached instance for which the parameters should be updated. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	586	body: object, The request body.
				587	The object takes the form of:
				588
				589	{ # Request for UpdateParameters.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	590	"parameters": { # 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	"id": "A String", # Output only.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	592	"params": { # User defined set of parameters to use in the memcached process.
				593	"a_key": "A String",
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	594	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	595	},
				596	"updateMask": "A String", # Required. Mask of fields to update.
				597	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	598
				599	x__xgafv: string, V1 error format.
				600	Allowed values
				601	1 - v1 error format
				602	2 - v2 error format
				603
				604	Returns:
				605	An object of the form:
				606
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	607	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	608	"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
				609	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
				610	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				611	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				612	{
				613	"a_key": "", # Properties of the object. Contains field @type with type URL.
				614	},
				615	],
				616	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
				617	},
				618	"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
				619	"a_key": "", # Properties of the object. Contains field @type with type URL.
				620	},
				621	"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
				622	"response": { # 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	"a_key": "", # Properties of the object. Contains field @type with type URL.
				624	},
				625	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	626	</div>
				627
				628	</body></html>