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

<h1><a href="tpu_v1.html">Cloud TPU API</a> . <a href="tpu_v1.projects.html">projects</a> . <a href="tpu_v1.projects.locations.html">locations</a> . <a href="tpu_v1.projects.locations.nodes.html">nodes</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#create">create(parent, body, nodeId=None, x__xgafv=None)</a></code></p>

79

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

80

81

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

82

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

83

84

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

85

<p class="firstline">Gets the details of a node.</p>

86

87

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

88

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

89

90

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

91

<p class="firstline">Retrieves the next page of results.</p>

92

93

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

94

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

95

96

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

97

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

98

99

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

100

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

101

<h3>Method Details</h3>

102

103

<code class="details" id="create">create(parent, body, nodeId=None, x__xgafv=None)</code>

<pre>Creates a node.

Args:

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

108

body: object, The request body. (required)

109

The object takes the form of:

110

111

{ # A TPU instance.

112

"schedulingConfig": {

113

"preemptible": True or False,

114

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

115

},

116

"cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address.

117

# This CIDR block must be a /29 block; the Compute Engine networks API

118

# forbids a smaller block, and using a larger block would be wasteful (a

119

# node can only consume one IP address). Errors will occur if the CIDR block

120

# has already been used for a currently existing TPU node, the CIDR block

121

# conflicts with any subnetworks in the user's provided network, or the

122

# provided network is peered with another network that is using that CIDR

123

# block.

124

# Required.

125

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

126

"healthDescription": "A String", # Output only.

127

# If this field is populated, it contains a description of why the TPU Node

128

# is unhealthy.

129

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

130

"a_key": "A String",

131

},

132

"serviceAccount": "A String", # Output only.

133

# The service account used to run the tensor flow services within the node.

134

# To share resources, including Google Cloud Storage data, with the

135

# Tensorflow job running in the Node, this account must have permissions to

136

# that data.

137

"createTime": "A String", # Output only.

138

# The time when the node was created.

139

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

140

# Required.

141

"network": "A String", # The name of a network they wish to peer the TPU node to. It must be a

142

# preexisting Compute Engine network inside of the project on which this API

143

# has been activated. If none is provided, "default" will be used.

144

"state": "A String", # Output only.

145

# The current state for the TPU Node.

146

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

147

"networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and

148

# sent work. It is recommended that Tensorflow clients of the node reach out

149

# to the 0th entry in this map first.

150

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

151

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

152

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

153

},

154

],

155

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

156

# Required.

157

"ipAddress": "A String", # Output only.

158

# DEPRECATED! Use network_endpoints instead.

159

# The network address for the TPU Node as visible to Compute Engine

160

# instances.

161

"port": "A String", # Output only.

162

# DEPRECATED! Use network_endpoints instead.

163

# The network port for the TPU Node as visible to Compute Engine instances.

164

"name": "A String", # Output only.

165

# The immutable name of the TPU

166

}

167

168

nodeId: string, The unqualified resource name.

169

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

176

177

{ # This resource represents a long-running operation that is the result of a

178

# network API call.

179

"metadata": { # Service-specific metadata associated with the operation. It typically

180

# contains progress information and common metadata such as create time.

181

# Some services might not provide such metadata. Any method that returns a

182

# long-running operation should document the metadata type, if any.

183

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

184

},

185

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

186

# different programming environments, including REST APIs and RPC APIs. It is

187

# used by [gRPC](https://github.com/grpc). The error model is designed to be:

188

#

189

# - Simple to use and understand for most users

190

# - Flexible enough to meet unexpected needs

#

# # Overview

#

# The `Status` message contains three pieces of data: error code, error

195

# message, and error details. The error code should be an enum value of

196

# google.rpc.Code, but it may accept additional error codes if needed. The

197

# error message should be a developer-facing English message that helps

198

# developers *understand* and *resolve* the error. If a localized user-facing

199

# error message is needed, put the localized message in the error details or

200

# localize it in the client. The optional error details may contain arbitrary

201

# information about the error. There is a predefined set of error detail types

202

# in the package `google.rpc` that can be used for common error conditions.

#

# # Language mapping

#

# The `Status` message is the logical representation of the error model, but it

207

# is not necessarily the actual wire format. When the `Status` message is

208

# exposed in different client libraries and different wire protocols, it can be

209

# mapped differently. For example, it will likely be mapped to some exceptions

210

# in Java, but more likely mapped to some error codes in C.

#

# # Other uses

#

# The error model and the `Status` message can be used in a variety of

215

# environments, either with or without APIs, to provide a

216

# consistent developer experience across different environments.

217

#

218

# Example uses of this error model include:

219

#

220

# - Partial errors. If a service needs to return partial errors to the client,

221

# it may embed the `Status` in the normal response to indicate the partial

222

# errors.

223

#

224

# - Workflow errors. A typical workflow has multiple steps. Each step may

225

# have a `Status` message for error reporting.

226

#

227

# - Batch operations. If a client uses batch request and batch response, the

228

# `Status` message should be used directly inside batch response, one for

229

# each error sub-response.

230

#

231

# - Asynchronous operations. If an API call embeds asynchronous operation

232

# results in its response, the status of those operations should be

233

# represented directly using the `Status` message.

234

#

235

# - Logging. If some API errors are stored in logs, the message `Status` could

236

# be used directly after any stripping needed for security/privacy reasons.

237

"message": "A String", # A developer-facing error message, which should be in English. Any

238

# user-facing error message should be localized and sent in the

239

# google.rpc.Status.details field, or localized by the client.

240

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

241

"details": [ # A list of messages that carry the error details. There is a common set of

242

# message types for APIs to use.

243

{

244

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

},

],

},

"done": True or False, # If the value is `false`, it means the operation is still in progress.

249

# If `true`, the operation is completed, and either `error` or `response` is

250

# available.

251

"response": { # The normal response of the operation in case of success. If the original

252

# method returns no data on success, such as `Delete`, the response is

253

# `google.protobuf.Empty`. If the original method is standard

254

# `Get`/`Create`/`Update`, the response should be the resource. For other

255

# methods, the response should have the type `XxxResponse`, where `Xxx`

256

# is the original method name. For example, if the original method name

257

# is `TakeSnapshot()`, the inferred response type is

258

# `TakeSnapshotResponse`.

259

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

260

},

261

"name": "A String", # The server-assigned name, which is only unique within the same service that

262

# originally returns it. If you use the default HTTP mapping, the

263

# `name` should be a resource name ending with `operations/{unique_id}`.

}</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:

280

281

{ # This resource represents a long-running operation that is the result of a

282

# network API call.

283

"metadata": { # Service-specific metadata associated with the operation. It typically

284

# contains progress information and common metadata such as create time.

285

# Some services might not provide such metadata. Any method that returns a

286

# long-running operation should document the metadata type, if any.

287

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

288

},

289

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

290

# different programming environments, including REST APIs and RPC APIs. It is

291

# used by [gRPC](https://github.com/grpc). The error model is designed to be:

292

#

293

# - Simple to use and understand for most users

294

# - Flexible enough to meet unexpected needs

#

# # Overview

#

# The `Status` message contains three pieces of data: error code, error

299

# message, and error details. The error code should be an enum value of

300

# google.rpc.Code, but it may accept additional error codes if needed. The

301

# error message should be a developer-facing English message that helps

302

# developers *understand* and *resolve* the error. If a localized user-facing

303

# error message is needed, put the localized message in the error details or

304

# localize it in the client. The optional error details may contain arbitrary

305

# information about the error. There is a predefined set of error detail types

306

# in the package `google.rpc` that can be used for common error conditions.

#

# # Language mapping

#

# The `Status` message is the logical representation of the error model, but it

311

# is not necessarily the actual wire format. When the `Status` message is

312

# exposed in different client libraries and different wire protocols, it can be

313

# mapped differently. For example, it will likely be mapped to some exceptions

314

# in Java, but more likely mapped to some error codes in C.

#

# # Other uses

#

# The error model and the `Status` message can be used in a variety of

319

# environments, either with or without APIs, to provide a

320

# consistent developer experience across different environments.

321

#

322

# Example uses of this error model include:

323

#

324

# - Partial errors. If a service needs to return partial errors to the client,

325

# it may embed the `Status` in the normal response to indicate the partial

326

# errors.

327

#

328

# - Workflow errors. A typical workflow has multiple steps. Each step may

329

# have a `Status` message for error reporting.

330

#

331

# - Batch operations. If a client uses batch request and batch response, the

332

# `Status` message should be used directly inside batch response, one for

333

# each error sub-response.

334

#

335

# - Asynchronous operations. If an API call embeds asynchronous operation

336

# results in its response, the status of those operations should be

337

# represented directly using the `Status` message.

338

#

339

# - Logging. If some API errors are stored in logs, the message `Status` could

340

# be used directly after any stripping needed for security/privacy reasons.

341

"message": "A String", # A developer-facing error message, which should be in English. Any

342

# user-facing error message should be localized and sent in the

343

# google.rpc.Status.details field, or localized by the client.

344

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

345

"details": [ # A list of messages that carry the error details. There is a common set of

346

# message types for APIs to use.

347

{

348

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

},

],

},

"done": True or False, # If the value is `false`, it means the operation is still in progress.

353

# If `true`, the operation is completed, and either `error` or `response` is

354

# available.

355

"response": { # The normal response of the operation in case of success. If the original

356

# method returns no data on success, such as `Delete`, the response is

357

# `google.protobuf.Empty`. If the original method is standard

358

# `Get`/`Create`/`Update`, the response should be the resource. For other

359

# methods, the response should have the type `XxxResponse`, where `Xxx`

360

# is the original method name. For example, if the original method name

361

# is `TakeSnapshot()`, the inferred response type is

362

# `TakeSnapshotResponse`.

363

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

364

},

365

"name": "A String", # The server-assigned name, which is only unique within the same service that

366

# originally returns it. If you use the default HTTP mapping, the

367

# `name` should be a resource name ending with `operations/{unique_id}`.

}</pre>

</div>

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

373

<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:

384

385

{ # A TPU instance.

386

"schedulingConfig": {

387

"preemptible": True or False,

388

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

389

},

390

"cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address.

391

# This CIDR block must be a /29 block; the Compute Engine networks API

392

# forbids a smaller block, and using a larger block would be wasteful (a

393

# node can only consume one IP address). Errors will occur if the CIDR block

394

# has already been used for a currently existing TPU node, the CIDR block

395

# conflicts with any subnetworks in the user's provided network, or the

396

# provided network is peered with another network that is using that CIDR

397

# block.

398

# Required.

399

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

400

"healthDescription": "A String", # Output only.

401

# If this field is populated, it contains a description of why the TPU Node

402

# is unhealthy.

403

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

404

"a_key": "A String",

405

},

406

"serviceAccount": "A String", # Output only.

407

# The service account used to run the tensor flow services within the node.

408

# To share resources, including Google Cloud Storage data, with the

409

# Tensorflow job running in the Node, this account must have permissions to

410

# that data.

411

"createTime": "A String", # Output only.

412

# The time when the node was created.

413

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

414

# Required.

415

"network": "A String", # The name of a network they wish to peer the TPU node to. It must be a

416

# preexisting Compute Engine network inside of the project on which this API

417

# has been activated. If none is provided, "default" will be used.

418

"state": "A String", # Output only.

419

# The current state for the TPU Node.

420

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

421

"networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and

422

# sent work. It is recommended that Tensorflow clients of the node reach out

423

# to the 0th entry in this map first.

424

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

425

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

426

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

427

},

428

],

429

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

430

# Required.

431

"ipAddress": "A String", # Output only.

432

# DEPRECATED! Use network_endpoints instead.

433

# The network address for the TPU Node as visible to Compute Engine

434

# instances.

435

"port": "A String", # Output only.

436

# DEPRECATED! Use network_endpoints instead.

437

# The network port for the TPU Node as visible to Compute Engine instances.

438

"name": "A String", # Output only.

439

# The immutable name of the TPU

}</pre>

</div>

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

<pre>Lists nodes.

Args:

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

449

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

450

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

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

455

456

Returns:

457

An object of the form:

458

459

{ # Response for ListNodes.

460

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

461

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

462

"A String",

463

],

464

"nodes": [ # The listed nodes.

465

{ # A TPU instance.

466

"schedulingConfig": {

467

"preemptible": True or False,

468

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

469

},

470

"cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address.

471

# This CIDR block must be a /29 block; the Compute Engine networks API

472

# forbids a smaller block, and using a larger block would be wasteful (a

473

# node can only consume one IP address). Errors will occur if the CIDR block

474

# has already been used for a currently existing TPU node, the CIDR block

475

# conflicts with any subnetworks in the user's provided network, or the

476

# provided network is peered with another network that is using that CIDR

477

# block.

478

# Required.

479

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

480

"healthDescription": "A String", # Output only.

481

# If this field is populated, it contains a description of why the TPU Node

482

# is unhealthy.

483

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

484

"a_key": "A String",

485

},

486

"serviceAccount": "A String", # Output only.

487

# The service account used to run the tensor flow services within the node.

488

# To share resources, including Google Cloud Storage data, with the

489

# Tensorflow job running in the Node, this account must have permissions to

490

# that data.

491

"createTime": "A String", # Output only.

492

# The time when the node was created.

493

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

494

# Required.

495

"network": "A String", # The name of a network they wish to peer the TPU node to. It must be a

496

# preexisting Compute Engine network inside of the project on which this API

497

# has been activated. If none is provided, "default" will be used.

498

"state": "A String", # Output only.

499

# The current state for the TPU Node.

500

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

501

"networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and

502

# sent work. It is recommended that Tensorflow clients of the node reach out

503

# to the 0th entry in this map first.

504

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

505

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

506

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

507

},

508

],

509

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

510

# Required.

511

"ipAddress": "A String", # Output only.

512

# DEPRECATED! Use network_endpoints instead.

513

# The network address for the TPU Node as visible to Compute Engine

514

# instances.

515

"port": "A String", # Output only.

516

# DEPRECATED! Use network_endpoints instead.

517

# The network port for the TPU Node as visible to Compute Engine instances.

518

"name": "A String", # Output only.

519

# The immutable name of the TPU

},

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

527

<pre>Retrieves the next page of results.

528

529

Args:

530

previous_request: The request for the previous page. (required)

531

previous_response: The response from the request for the previous page. (required)

532

533

Returns:

534

A request object that you can call 'execute()' on to request the next

535

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

</pre>

</div>

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

541

<pre>Reimages a node's OS.

Args:

body: object, The request body. (required)

546

The object takes the form of:

547

548

{ # Request for ReimageNode.

549

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

550

}

551

552

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

559

560

{ # This resource represents a long-running operation that is the result of a

561

# network API call.

562

"metadata": { # Service-specific metadata associated with the operation. It typically

563

# contains progress information and common metadata such as create time.

564

# Some services might not provide such metadata. Any method that returns a

565

# long-running operation should document the metadata type, if any.

566

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

567

},

568

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

569

# different programming environments, including REST APIs and RPC APIs. It is

570

# used by [gRPC](https://github.com/grpc). The error model is designed to be:

571

#

572

# - Simple to use and understand for most users

573

# - Flexible enough to meet unexpected needs

#

# # Overview

#

# The `Status` message contains three pieces of data: error code, error

578

# message, and error details. The error code should be an enum value of

579

# google.rpc.Code, but it may accept additional error codes if needed. The

580

# error message should be a developer-facing English message that helps

581

# developers *understand* and *resolve* the error. If a localized user-facing

582

# error message is needed, put the localized message in the error details or

583

# localize it in the client. The optional error details may contain arbitrary

584

# information about the error. There is a predefined set of error detail types

585

# in the package `google.rpc` that can be used for common error conditions.

#

# # Language mapping

#

# The `Status` message is the logical representation of the error model, but it

590

# is not necessarily the actual wire format. When the `Status` message is

591

# exposed in different client libraries and different wire protocols, it can be

592

# mapped differently. For example, it will likely be mapped to some exceptions

593

# in Java, but more likely mapped to some error codes in C.

#

# # Other uses

#

# The error model and the `Status` message can be used in a variety of

598

# environments, either with or without APIs, to provide a

599

# consistent developer experience across different environments.

600

#

601

# Example uses of this error model include:

602

#

603

# - Partial errors. If a service needs to return partial errors to the client,

604

# it may embed the `Status` in the normal response to indicate the partial

605

# errors.

606

#

607

# - Workflow errors. A typical workflow has multiple steps. Each step may

608

# have a `Status` message for error reporting.

609

#

610

# - Batch operations. If a client uses batch request and batch response, the

611

# `Status` message should be used directly inside batch response, one for

612

# each error sub-response.

613

#

614

# - Asynchronous operations. If an API call embeds asynchronous operation

615

# results in its response, the status of those operations should be

616

# represented directly using the `Status` message.

617

#

618

# - Logging. If some API errors are stored in logs, the message `Status` could

619

# be used directly after any stripping needed for security/privacy reasons.

620

"message": "A String", # A developer-facing error message, which should be in English. Any

621

# user-facing error message should be localized and sent in the

622

# google.rpc.Status.details field, or localized by the client.

623

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

624

"details": [ # A list of messages that carry the error details. There is a common set of

625

# message types for APIs to use.

626

{

627

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

},

],

},

"done": True or False, # If the value is `false`, it means the operation is still in progress.

632

# If `true`, the operation is completed, and either `error` or `response` is

633

# available.

634

"response": { # The normal response of the operation in case of success. If the original

635

# method returns no data on success, such as `Delete`, the response is

636

# `google.protobuf.Empty`. If the original method is standard

637

# `Get`/`Create`/`Update`, the response should be the resource. For other

638

# methods, the response should have the type `XxxResponse`, where `Xxx`

639

# is the original method name. For example, if the original method name

640

# is `TakeSnapshot()`, the inferred response type is

641

# `TakeSnapshotResponse`.

642

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

643

},

644

"name": "A String", # The server-assigned name, which is only unique within the same service that

645

# originally returns it. If you use the default HTTP mapping, the

646

# `name` should be a resource name ending with `operations/{unique_id}`.

}</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.

657

The object takes the form of:

658

659

{ # Request for StartNode.

660

}

661

662

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

669

670

{ # This resource represents a long-running operation that is the result of a

671

# network API call.

672

"metadata": { # Service-specific metadata associated with the operation. It typically

673

# contains progress information and common metadata such as create time.

674

# Some services might not provide such metadata. Any method that returns a

675

# long-running operation should document the metadata type, if any.

676

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

677

},

678

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

679

# different programming environments, including REST APIs and RPC APIs. It is

680

# used by [gRPC](https://github.com/grpc). The error model is designed to be:

681

#

682

# - Simple to use and understand for most users

683

# - Flexible enough to meet unexpected needs

#

# # Overview

#

# The `Status` message contains three pieces of data: error code, error

688

# message, and error details. The error code should be an enum value of

689

# google.rpc.Code, but it may accept additional error codes if needed. The

690

# error message should be a developer-facing English message that helps

691

# developers *understand* and *resolve* the error. If a localized user-facing

692

# error message is needed, put the localized message in the error details or

693

# localize it in the client. The optional error details may contain arbitrary

694

# information about the error. There is a predefined set of error detail types

695

# in the package `google.rpc` that can be used for common error conditions.

#

# # Language mapping

#

# The `Status` message is the logical representation of the error model, but it

700

# is not necessarily the actual wire format. When the `Status` message is

701

# exposed in different client libraries and different wire protocols, it can be

702

# mapped differently. For example, it will likely be mapped to some exceptions

703

# in Java, but more likely mapped to some error codes in C.

#

# # Other uses

#

# The error model and the `Status` message can be used in a variety of

708

# environments, either with or without APIs, to provide a

709

# consistent developer experience across different environments.

710

#

711

# Example uses of this error model include:

712

#

713

# - Partial errors. If a service needs to return partial errors to the client,

714

# it may embed the `Status` in the normal response to indicate the partial

715

# errors.

716

#

717

# - Workflow errors. A typical workflow has multiple steps. Each step may

718

# have a `Status` message for error reporting.

719

#

720

# - Batch operations. If a client uses batch request and batch response, the

721

# `Status` message should be used directly inside batch response, one for

722

# each error sub-response.

723

#

724

# - Asynchronous operations. If an API call embeds asynchronous operation

725

# results in its response, the status of those operations should be

726

# represented directly using the `Status` message.

727

#

728

# - Logging. If some API errors are stored in logs, the message `Status` could

729

# be used directly after any stripping needed for security/privacy reasons.

730

"message": "A String", # A developer-facing error message, which should be in English. Any

731

# user-facing error message should be localized and sent in the

732

# google.rpc.Status.details field, or localized by the client.

733

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

734

"details": [ # A list of messages that carry the error details. There is a common set of

735

# message types for APIs to use.

736

{

737

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

},

],

},

"done": True or False, # If the value is `false`, it means the operation is still in progress.

742

# If `true`, the operation is completed, and either `error` or `response` is

743

# available.

744

"response": { # The normal response of the operation in case of success. If the original

745

# method returns no data on success, such as `Delete`, the response is

746

# `google.protobuf.Empty`. If the original method is standard

747

# `Get`/`Create`/`Update`, the response should be the resource. For other

748

# methods, the response should have the type `XxxResponse`, where `Xxx`

749

# is the original method name. For example, if the original method name

750

# is `TakeSnapshot()`, the inferred response type is

751

# `TakeSnapshotResponse`.

752

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

753

},

754

"name": "A String", # The server-assigned name, which is only unique within the same service that

755

# originally returns it. If you use the default HTTP mapping, the

756

# `name` should be a resource name ending with `operations/{unique_id}`.

}</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.

767

The object takes the form of:

768

769

{ # Request for StopNode.

770

}

771

772

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

779

780

{ # This resource represents a long-running operation that is the result of a

781

# network API call.

782

"metadata": { # Service-specific metadata associated with the operation. It typically

783

# contains progress information and common metadata such as create time.

784

# Some services might not provide such metadata. Any method that returns a

785

# long-running operation should document the metadata type, if any.

786

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

787

},

788

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

789

# different programming environments, including REST APIs and RPC APIs. It is

790

# used by [gRPC](https://github.com/grpc). The error model is designed to be:

791

#

792

# - Simple to use and understand for most users

793

# - Flexible enough to meet unexpected needs

#

# # Overview

#

# The `Status` message contains three pieces of data: error code, error

798

# message, and error details. The error code should be an enum value of

799

# google.rpc.Code, but it may accept additional error codes if needed. The

800

# error message should be a developer-facing English message that helps

801

# developers *understand* and *resolve* the error. If a localized user-facing

802

# error message is needed, put the localized message in the error details or

803

# localize it in the client. The optional error details may contain arbitrary

804

# information about the error. There is a predefined set of error detail types

805

# in the package `google.rpc` that can be used for common error conditions.

#

# # Language mapping

#

# The `Status` message is the logical representation of the error model, but it

810

# is not necessarily the actual wire format. When the `Status` message is

811

# exposed in different client libraries and different wire protocols, it can be

812

# mapped differently. For example, it will likely be mapped to some exceptions

813

# in Java, but more likely mapped to some error codes in C.

#

# # Other uses

#

# The error model and the `Status` message can be used in a variety of

818

# environments, either with or without APIs, to provide a

819

# consistent developer experience across different environments.

820

#

821

# Example uses of this error model include:

822

#

823

# - Partial errors. If a service needs to return partial errors to the client,

824

# it may embed the `Status` in the normal response to indicate the partial

825

# errors.

826

#

827

# - Workflow errors. A typical workflow has multiple steps. Each step may

828

# have a `Status` message for error reporting.

829

#

830

# - Batch operations. If a client uses batch request and batch response, the

831

# `Status` message should be used directly inside batch response, one for

832

# each error sub-response.

833

#

834

# - Asynchronous operations. If an API call embeds asynchronous operation

835

# results in its response, the status of those operations should be

836

# represented directly using the `Status` message.

837

#

838

# - Logging. If some API errors are stored in logs, the message `Status` could

839

# be used directly after any stripping needed for security/privacy reasons.

840

"message": "A String", # A developer-facing error message, which should be in English. Any

841

# user-facing error message should be localized and sent in the

842

# google.rpc.Status.details field, or localized by the client.

843

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

844

"details": [ # A list of messages that carry the error details. There is a common set of

845

# message types for APIs to use.

846

{

847

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

},

],

},

"done": True or False, # If the value is `false`, it means the operation is still in progress.

852

# If `true`, the operation is completed, and either `error` or `response` is

853

# available.

854

"response": { # The normal response of the operation in case of success. If the original

855

# method returns no data on success, such as `Delete`, the response is

856

# `google.protobuf.Empty`. If the original method is standard

857

# `Get`/`Create`/`Update`, the response should be the resource. For other

858

# methods, the response should have the type `XxxResponse`, where `Xxx`

859

# is the original method name. For example, if the original method name

860

# is `TakeSnapshot()`, the inferred response type is

861

# `TakeSnapshotResponse`.

862

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

863

},

864

"name": "A String", # The server-assigned name, which is only unique within the same service that

865

# originally returns it. If you use the default HTTP mapping, the

866

# `name` should be a resource name ending with `operations/{unique_id}`.

}</pre>

</div>

</body></html>