Blame - docs/dyn/tpu_v1alpha1.projects.locations.nodes.html - platform/external/python/google-api-python-client

blob: 65c864127c6d92a9b57cf7294ec5a1bccd4e97d0 [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -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="tpu_v1alpha1.html">Cloud TPU API</a> . <a href="tpu_v1alpha1.projects.html">projects</a> . <a href="tpu_v1alpha1.projects.locations.html">locations</a> . <a href="tpu_v1alpha1.projects.locations.nodes.html">nodes</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	81	<code><a href="#create">create(parent, body=None, nodeId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	82	<p class="firstline">Creates a node.</p>
				83	<p class="toc_element">
				84	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Deletes a node.</p>
				86	<p class="toc_element">
				87	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				88	<p class="firstline">Gets the details of a node.</p>
				89	<p class="toc_element">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	90	<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	91	<p class="firstline">Lists nodes.</p>
				92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	96	<code><a href="#reimage">reimage(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	97	<p class="firstline">Reimages a node's OS.</p>
				98	<p class="toc_element">
				99	<code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p>
				100	<p class="firstline">Starts a node.</p>
				101	<p class="toc_element">
				102	<code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p>
				103	<p class="firstline">Stops a node.</p>
				104	<h3>Method Details</h3>
				105	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	106	<code class="details" id="close">close()</code>
				107	<pre>Close httplib2 connections.</pre>
				108	</div>
				109
				110	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	111	<code class="details" id="create">create(parent, body=None, nodeId=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	112	<pre>Creates a node.
				113
				114	Args:
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	115	parent: string, Required. The parent resource name. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	116	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	117	The object takes the form of:
				118
				119	{ # A TPU instance.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	120	"cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block.
				121	"networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first.
				122	{ # A network endpoint over which a TPU worker can be reached.
				123	"ipAddress": "A String", # The IP address of this network endpoint.
				124	"port": 42, # The port of this network endpoint.
				125	},
				126	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	127	"schedulingConfig": { # Sets the scheduling options for this node. # The scheduling options for this node.
				128	"preemptible": True or False, # Defines whether the node is preemptible.
				129	"reserved": True or False, # Whether the node is created under a reservation.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	130	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	131	"useServiceNetworking": True or False, # Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled.
				132	"network": "A String", # The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used.
				133	"health": "A String", # The health status of the TPU node.
				134	"state": "A String", # Output only. The current state for the TPU Node.
				135	"serviceAccount": "A String", # Output only. The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data.
				136	"acceleratorType": "A String", # Required. The type of hardware accelerators associated with this node.
				137	"description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
				138	"name": "A String", # Output only. Immutable. The name of the TPU
				139	"ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	140	"labels": { # Resource labels to represent user-provided metadata.
				141	"a_key": "A String",
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	142	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	143	"tensorflowVersion": "A String", # Required. The version of Tensorflow running in the Node.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	144	"symptoms": [ # Output only. The Symptoms that have occurred to the TPU Node.
				145	{ # A Symptom instance.
				146	"workerId": "A String", # A string used to uniquely distinguish a worker within a TPU node.
				147	"details": "A String", # Detailed information of the current Symptom.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	148	"symptomType": "A String", # Type of the Symptom.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	149	"createTime": "A String", # Timestamp when the Symptom is created.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	150	},
				151	],
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	152	"healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.
				153	"port": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.
				154	"createTime": "A String", # Output only. The time when the node was created.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	155	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	156
				157	nodeId: string, The unqualified resource name.
				158	x__xgafv: string, V1 error format.
				159	Allowed values
				160	1 - v1 error format
				161	2 - v2 error format
				162
				163	Returns:
				164	An object of the form:
				165
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	166	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	167	"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.
				168	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	169	"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.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	170	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	171	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	172	{
				173	"a_key": "", # Properties of the object. Contains field @type with type URL.
				174	},
				175	],
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	176	"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.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	177	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	178	"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.
				179	"a_key": "", # Properties of the object. Contains field @type with type URL.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	180	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	181	"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`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	182	"a_key": "", # Properties of the object. Contains field @type with type URL.
				183	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	184	}</pre>
				185	</div>
				186
				187	<div class="method">
				188	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				189	<pre>Deletes a node.
				190
				191	Args:
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	192	name: string, Required. The resource name. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	193	x__xgafv: string, V1 error format.
				194	Allowed values
				195	1 - v1 error format
				196	2 - v2 error format
				197
				198	Returns:
				199	An object of the form:
				200
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	201	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	202	"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.
				203	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	204	"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.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	205	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	206	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	207	{
				208	"a_key": "", # Properties of the object. Contains field @type with type URL.
				209	},
				210	],
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	211	"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.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	212	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	213	"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.
				214	"a_key": "", # Properties of the object. Contains field @type with type URL.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	215	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	216	"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`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	217	"a_key": "", # Properties of the object. Contains field @type with type URL.
				218	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	219	}</pre>
				220	</div>
				221
				222	<div class="method">
				223	<code class="details" id="get">get(name, x__xgafv=None)</code>
				224	<pre>Gets the details of a node.
				225
				226	Args:
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	227	name: string, Required. The resource name. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	228	x__xgafv: string, V1 error format.
				229	Allowed values
				230	1 - v1 error format
				231	2 - v2 error format
				232
				233	Returns:
				234	An object of the form:
				235
				236	{ # A TPU instance.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	237	"cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block.
				238	"networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first.
				239	{ # A network endpoint over which a TPU worker can be reached.
				240	"ipAddress": "A String", # The IP address of this network endpoint.
				241	"port": 42, # The port of this network endpoint.
				242	},
				243	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	244	"schedulingConfig": { # Sets the scheduling options for this node. # The scheduling options for this node.
				245	"preemptible": True or False, # Defines whether the node is preemptible.
				246	"reserved": True or False, # Whether the node is created under a reservation.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	247	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	248	"useServiceNetworking": True or False, # Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled.
				249	"network": "A String", # The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used.
				250	"health": "A String", # The health status of the TPU node.
				251	"state": "A String", # Output only. The current state for the TPU Node.
				252	"serviceAccount": "A String", # Output only. The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data.
				253	"acceleratorType": "A String", # Required. The type of hardware accelerators associated with this node.
				254	"description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
				255	"name": "A String", # Output only. Immutable. The name of the TPU
				256	"ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	257	"labels": { # Resource labels to represent user-provided metadata.
				258	"a_key": "A String",
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	259	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	260	"tensorflowVersion": "A String", # Required. The version of Tensorflow running in the Node.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	261	"symptoms": [ # Output only. The Symptoms that have occurred to the TPU Node.
				262	{ # A Symptom instance.
				263	"workerId": "A String", # A string used to uniquely distinguish a worker within a TPU node.
				264	"details": "A String", # Detailed information of the current Symptom.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	265	"symptomType": "A String", # Type of the Symptom.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	266	"createTime": "A String", # Timestamp when the Symptom is created.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	267	},
				268	],
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	269	"healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.
				270	"port": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.
				271	"createTime": "A String", # Output only. The time when the node was created.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	272	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	273	</div>
				274
				275	<div class="method">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	276	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	277	<pre>Lists nodes.
				278
				279	Args:
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	280	parent: string, Required. The parent resource name. (required)
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	281	pageSize: integer, The maximum number of items to return.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	282	pageToken: string, The next_page_token value returned from a previous List request, if any.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	283	x__xgafv: string, V1 error format.
				284	Allowed values
				285	1 - v1 error format
				286	2 - v2 error format
				287
				288	Returns:
				289	An object of the form:
				290
				291	{ # Response for ListNodes.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	292	"nextPageToken": "A String", # The next page token or empty if none.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	293	"unreachable": [ # Locations that could not be reached.
				294	"A String",
				295	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	296	"nodes": [ # The listed nodes.
				297	{ # A TPU instance.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	298	"cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block.
				299	"networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first.
				300	{ # A network endpoint over which a TPU worker can be reached.
				301	"ipAddress": "A String", # The IP address of this network endpoint.
				302	"port": 42, # The port of this network endpoint.
				303	},
				304	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	305	"schedulingConfig": { # Sets the scheduling options for this node. # The scheduling options for this node.
				306	"preemptible": True or False, # Defines whether the node is preemptible.
				307	"reserved": True or False, # Whether the node is created under a reservation.
				308	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	309	"useServiceNetworking": True or False, # Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled.
				310	"network": "A String", # The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used.
				311	"health": "A String", # The health status of the TPU node.
				312	"state": "A String", # Output only. The current state for the TPU Node.
				313	"serviceAccount": "A String", # Output only. The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data.
				314	"acceleratorType": "A String", # Required. The type of hardware accelerators associated with this node.
				315	"description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
				316	"name": "A String", # Output only. Immutable. The name of the TPU
				317	"ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	318	"labels": { # Resource labels to represent user-provided metadata.
				319	"a_key": "A String",
				320	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	321	"tensorflowVersion": "A String", # Required. The version of Tensorflow running in the Node.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	322	"symptoms": [ # Output only. The Symptoms that have occurred to the TPU Node.
				323	{ # A Symptom instance.
				324	"workerId": "A String", # A string used to uniquely distinguish a worker within a TPU node.
				325	"details": "A String", # Detailed information of the current Symptom.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	326	"symptomType": "A String", # Type of the Symptom.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	327	"createTime": "A String", # Timestamp when the Symptom is created.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	328	},
				329	],
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	330	"healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.
				331	"port": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.
				332	"createTime": "A String", # Output only. The time when the node was created.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	333	},
				334	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	335	}</pre>
				336	</div>
				337
				338	<div class="method">
				339	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				340	<pre>Retrieves the next page of results.
				341
				342	Args:
				343	previous_request: The request for the previous page. (required)
				344	previous_response: The response from the request for the previous page. (required)
				345
				346	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	347	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	348	page. Returns None if there are no more items in the collection.
				349	</pre>
				350	</div>
				351
				352	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	353	<code class="details" id="reimage">reimage(name, body=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	354	<pre>Reimages a node's OS.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	355
				356	Args:
				357	name: string, The resource name. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	358	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	359	The object takes the form of:
				360
				361	{ # Request for ReimageNode.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	362	"tensorflowVersion": "A String", # The version for reimage to create.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	363	}
				364
				365	x__xgafv: string, V1 error format.
				366	Allowed values
				367	1 - v1 error format
				368	2 - v2 error format
				369
				370	Returns:
				371	An object of the form:
				372
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	373	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	374	"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.
				375	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	376	"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.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	377	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	378	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	379	{
				380	"a_key": "", # Properties of the object. Contains field @type with type URL.
				381	},
				382	],
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	383	"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.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	384	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	385	"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.
				386	"a_key": "", # Properties of the object. Contains field @type with type URL.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	387	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	388	"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`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	389	"a_key": "", # Properties of the object. Contains field @type with type URL.
				390	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	391	}</pre>
				392	</div>
				393
				394	<div class="method">
				395	<code class="details" id="start">start(name, body=None, x__xgafv=None)</code>
				396	<pre>Starts a node.
				397
				398	Args:
				399	name: string, The resource name. (required)
				400	body: object, The request body.
				401	The object takes the form of:
				402
				403	{ # Request for StartNode.
				404	}
				405
				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
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	414	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	415	"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.
				416	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	417	"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.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	418	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	419	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	420	{
				421	"a_key": "", # Properties of the object. Contains field @type with type URL.
				422	},
				423	],
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	424	"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.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	425	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	426	"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.
				427	"a_key": "", # Properties of the object. Contains field @type with type URL.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	428	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	429	"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`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	430	"a_key": "", # Properties of the object. Contains field @type with type URL.
				431	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	432	}</pre>
				433	</div>
				434
				435	<div class="method">
				436	<code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code>
				437	<pre>Stops a node.
				438
				439	Args:
				440	name: string, The resource name. (required)
				441	body: object, The request body.
				442	The object takes the form of:
				443
				444	{ # Request for StopNode.
				445	}
				446
				447	x__xgafv: string, V1 error format.
				448	Allowed values
				449	1 - v1 error format
				450	2 - v2 error format
				451
				452	Returns:
				453	An object of the form:
				454
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	455	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	456	"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.
				457	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	458	"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.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	459	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	460	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	461	{
				462	"a_key": "", # Properties of the object. Contains field @type with type URL.
				463	},
				464	],
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame^]	465	"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.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	466	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	467	"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.
				468	"a_key": "", # Properties of the object. Contains field @type with type URL.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	469	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	470	"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`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	471	"a_key": "", # Properties of the object. Contains field @type with type URL.
				472	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	473	}</pre>
				474	</div>
				475
				476	</body></html>