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

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

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

2019-06-14 16:50:42 -0700

[diff] [blame]

82

<p class="firstline">Creates a node.</p>

83

84

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

85

<p class="firstline">Deletes a node.</p>

86

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

90

<code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

91

<p class="firstline">Lists nodes.</p>

92

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

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

2019-06-14 16:50:42 -0700

[diff] [blame]

97

<p class="firstline">Reimages a node's OS.</p>

98

99

<code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p>

100

<p class="firstline">Starts a node.</p>

101

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

106

<code class="details" id="close">close()</code>

107

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

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

2019-06-14 16:50:42 -0700

[diff] [blame]

<pre>Creates a node.

Args:

parent: string, 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

2019-06-14 16:50:42 -0700

[diff] [blame]

117

The object takes the form of:

118

119

{ # A TPU instance.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

120

"description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.

121

"symptoms": [ # Output only. The Symptoms that have occurred to the TPU Node.

122

{ # A Symptom instance.

123

"workerId": "A String", # A string used to uniquely distinguish a worker within a TPU node.

124

"details": "A String", # Detailed information of the current Symptom.

125

"createTime": "A String", # Timestamp when the Symptom is created.

126

"symptomType": "A String", # Type of the Symptom.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

127

},

128

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

129

"acceleratorType": "A String", # The type of hardware accelerators associated with this node. Required.

130

"healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.

131

"tensorflowVersion": "A String", # The version of Tensorflow running in the Node. Required.

132

"health": "A String", # The health status of the TPU node.

133

"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.

134

"name": "A String", # Output only. The immutable name of the TPU

135

"createTime": "A String", # Output only. The time when the node was created.

136

"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.

137

"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.

138

{ # A network endpoint over which a TPU worker can be reached.

139

"ipAddress": "A String", # The IP address of this network endpoint.

140

"port": 42, # The port of this network endpoint.

141

},

142

],

143

"schedulingConfig": { # Sets the scheduling options for this node.

144

"preemptible": True or False, # Defines whether the node is preemptible.

145

"reserved": True or False, # Whether the node is created under a reservation.

146

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

147

"labels": { # Resource labels to represent user-provided metadata.

148

"a_key": "A String",

149

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

150

"port": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.

151

"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.

152

"ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.

153

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

154

"state": "A String", # Output only. The current state for the TPU Node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

155

}

156

157

nodeId: string, The unqualified resource name.

158

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

165

Dmitry Frenkel

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.

167

"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}`.

168

"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.

169

"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

2020-05-20 12:08:20 -0700

[diff] [blame]

170

{

171

"a_key": "", # Properties of the object. Contains field @type with type URL.

172

},

173

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

174

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

175

"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.

176

},

177

"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.

178

"a_key": "", # Properties of the object. Contains field @type with type URL.

179

},

180

"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.

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`.

182

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

183

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

<pre>Deletes a node.

Args:

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

200

Dmitry Frenkel

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.

202

"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}`.

203

"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.

204

"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

2020-05-20 12:08:20 -0700

[diff] [blame]

205

{

206

"a_key": "", # Properties of the object. Contains field @type with type URL.

207

},

208

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

209

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

210

"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.

211

},

212

"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.

213

"a_key": "", # Properties of the object. Contains field @type with type URL.

214

},

215

"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.

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`.

217

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

218

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

224

<pre>Gets the details of a node.

Args:

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

235

236

{ # A TPU instance.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

237

"description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.

238

"symptoms": [ # Output only. The Symptoms that have occurred to the TPU Node.

239

{ # A Symptom instance.

240

"workerId": "A String", # A string used to uniquely distinguish a worker within a TPU node.

241

"details": "A String", # Detailed information of the current Symptom.

242

"createTime": "A String", # Timestamp when the Symptom is created.

243

"symptomType": "A String", # Type of the Symptom.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

244

},

245

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

246

"acceleratorType": "A String", # The type of hardware accelerators associated with this node. Required.

247

"healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.

248

"tensorflowVersion": "A String", # The version of Tensorflow running in the Node. Required.

249

"health": "A String", # The health status of the TPU node.

250

"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.

251

"name": "A String", # Output only. The immutable name of the TPU

252

"createTime": "A String", # Output only. The time when the node was created.

253

"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.

254

"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.

255

{ # A network endpoint over which a TPU worker can be reached.

256

"ipAddress": "A String", # The IP address of this network endpoint.

257

"port": 42, # The port of this network endpoint.

258

},

259

],

260

"schedulingConfig": { # Sets the scheduling options for this node.

261

"preemptible": True or False, # Defines whether the node is preemptible.

262

"reserved": True or False, # Whether the node is created under a reservation.

263

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

264

"labels": { # Resource labels to represent user-provided metadata.

265

"a_key": "A String",

266

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

267

"port": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.

268

"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.

269

"ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.

270

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

271

"state": "A String", # Output only. The current state for the TPU Node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

276

<code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

<pre>Lists nodes.

Args:

parent: string, The parent resource name. (required)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

281

pageToken: string, The next_page_token value returned from a previous List request, if any.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

282

pageSize: integer, The maximum number of items to return.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

283

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

290

291

{ # Response for ListNodes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

292

"nodes": [ # The listed nodes.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

293

{ # A TPU instance.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

294

"description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.

295

"symptoms": [ # Output only. The Symptoms that have occurred to the TPU Node.

296

{ # A Symptom instance.

297

"workerId": "A String", # A string used to uniquely distinguish a worker within a TPU node.

298

"details": "A String", # Detailed information of the current Symptom.

299

"createTime": "A String", # Timestamp when the Symptom is created.

300

"symptomType": "A String", # Type of the Symptom.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

301

},

302

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

303

"acceleratorType": "A String", # The type of hardware accelerators associated with this node. Required.

304

"healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.

305

"tensorflowVersion": "A String", # The version of Tensorflow running in the Node. Required.

306

"health": "A String", # The health status of the TPU node.

307

"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.

308

"name": "A String", # Output only. The immutable name of the TPU

309

"createTime": "A String", # Output only. The time when the node was created.

310

"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.

311

"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.

312

{ # A network endpoint over which a TPU worker can be reached.

313

"ipAddress": "A String", # The IP address of this network endpoint.

314

"port": 42, # The port of this network endpoint.

315

},

316

],

317

"schedulingConfig": { # Sets the scheduling options for this node.

318

"preemptible": True or False, # Defines whether the node is preemptible.

319

"reserved": True or False, # Whether the node is created under a reservation.

320

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

321

"labels": { # Resource labels to represent user-provided metadata.

322

"a_key": "A String",

323

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

324

"port": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.

325

"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.

326

"ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.

327

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

328

"state": "A String", # Output only. The current state for the TPU Node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

329

},

330

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

331

"unreachable": [ # Locations that could not be reached.

332

"A String",

333

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

334

"nextPageToken": "A String", # The next page token or empty if none.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<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

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

2019-06-14 16:50:42 -0700

[diff] [blame]

348

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

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

2020-05-20 12:08:20 -0700

[diff] [blame]

354

<pre>Reimages a node's OS.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

358

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

359

The object takes the form of:

360

361

{ # Request for ReimageNode.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

362

"tensorflowVersion": "A String", # The version for reimage to create.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

363

}

364

365

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

372

Dmitry Frenkel

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.

374

"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}`.

375

"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.

376

"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

2020-05-20 12:08:20 -0700

[diff] [blame]

377

{

378

"a_key": "", # Properties of the object. Contains field @type with type URL.

379

},

380

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

381

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

382

"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.

383

},

384

"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.

385

"a_key": "", # Properties of the object. Contains field @type with type URL.

386

},

387

"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.

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`.

389

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

390

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="start">start(name, body=None, x__xgafv=None)</code>

<pre>Starts a node.

Args:

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.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

413

Dmitry Frenkel

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.

415

"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}`.

416

"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.

417

"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

2020-05-20 12:08:20 -0700

[diff] [blame]

418

{

419

"a_key": "", # Properties of the object. Contains field @type with type URL.

420

},

421

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

422

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

423

"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.

424

},

425

"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.

426

"a_key": "", # Properties of the object. Contains field @type with type URL.

427

},

428

"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.

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`.

430

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

431

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code>

<pre>Stops a node.

Args:

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.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

454

Dmitry Frenkel

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.

456

"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}`.

457

"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.

458

"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

2020-05-20 12:08:20 -0700

[diff] [blame]

459

{

460

"a_key": "", # Properties of the object. Contains field @type with type URL.

461

},

462

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

463

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

464

"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.

465

},

466

"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.

467

"a_key": "", # Properties of the object. Contains field @type with type URL.

468

},

469

"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.

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`.

471

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

472

},

Bu Sun Kim