Class: Google::Apis::TpuV1alpha1::TPUService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::TpuV1alpha1::TPUService
- Defined in:
- generated/google/apis/tpu_v1alpha1/service.rb
Overview
Cloud TPU API
TPU API provides customers with access to Google TPU technology.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#cancel_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::Empty
Starts asynchronous cancellation on a long-running operation.
-
#create_project_location_node(parent, node_object = nil, node_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::Operation
Creates a node.
-
#delete_project_location_node(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::Operation
Deletes a node.
-
#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::Empty
Deletes a long-running operation.
-
#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::Location
Get information about a location.
-
#get_project_location_node(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::Node
Gets the details of a node.
-
#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::Operation
Gets the latest state of a long-running operation.
-
#get_project_location_tensorflow_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::TensorFlowVersion
Gets TensorFlow Version.
-
#initialize ⇒ TPUService
constructor
A new instance of TPUService.
-
#list_project_location_nodes(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::ListNodesResponse
Lists nodes.
-
#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::ListOperationsResponse
Lists operations that match the specified filter in the request.
-
#list_project_location_tensorflow_versions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::ListTensorFlowVersionsResponse
Lists TensorFlow versions supported by this API.
-
#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::ListLocationsResponse
Lists information about the supported locations for this service.
-
#reimage_project_location_node(name, reimage_node_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::Operation
Reimages a node's OS.
-
#reset_project_location_node(name, reset_node_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::Operation
Resets a node, which stops and starts the VM.
-
#start_node(name, start_node_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::Operation
Starts a node.
-
#stop_node(name, stop_node_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::Operation
Stops a node.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ TPUService
Returns a new instance of TPUService
45 46 47 48 |
# File 'generated/google/apis/tpu_v1alpha1/service.rb', line 45 def initialize super('https://tpu.googleapis.com/', '') @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
38 39 40 |
# File 'generated/google/apis/tpu_v1alpha1/service.rb', line 38 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
43 44 45 |
# File 'generated/google/apis/tpu_v1alpha1/service.rb', line 43 def quota_user @quota_user end |
Instance Method Details
#cancel_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::Empty
Starts asynchronous cancellation on a long-running operation. The server
makes a best effort to cancel the operation, but success is not
guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Clients can use
Operations.GetOperation or
other methods to check whether the cancellation succeeded or whether the
operation completed despite cancellation. On successful cancellation,
the operation is not deleted; instead, it becomes an operation with
an Operation.error value with a google.rpc.Status.code of 1,
corresponding to Code.CANCELLED.
412 413 414 415 416 417 418 419 420 |
# File 'generated/google/apis/tpu_v1alpha1/service.rb', line 412 def cancel_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1alpha1/{+name}:cancel', ) command.response_representation = Google::Apis::TpuV1alpha1::Empty::Representation command.response_class = Google::Apis::TpuV1alpha1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_project_location_node(parent, node_object = nil, node_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::Operation
Creates a node.
142 143 144 145 146 147 148 149 150 151 152 153 |
# File 'generated/google/apis/tpu_v1alpha1/service.rb', line 142 def create_project_location_node(parent, node_object = nil, node_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1alpha1/{+parent}/nodes', ) command.request_representation = Google::Apis::TpuV1alpha1::Node::Representation command.request_object = node_object command.response_representation = Google::Apis::TpuV1alpha1::Operation::Representation command.response_class = Google::Apis::TpuV1alpha1::Operation command.params['parent'] = parent unless parent.nil? command.query['nodeId'] = node_id unless node_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_location_node(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::Operation
Deletes a node.
175 176 177 178 179 180 181 182 183 |
# File 'generated/google/apis/tpu_v1alpha1/service.rb', line 175 def delete_project_location_node(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1alpha1/{+name}', ) command.response_representation = Google::Apis::TpuV1alpha1::Operation::Representation command.response_class = Google::Apis::TpuV1alpha1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::Empty
Deletes a long-running operation. This method indicates that the client is
no longer interested in the operation result. It does not cancel the
operation. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED.
445 446 447 448 449 450 451 452 453 |
# File 'generated/google/apis/tpu_v1alpha1/service.rb', line 445 def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1alpha1/{+name}', ) command.response_representation = Google::Apis::TpuV1alpha1::Empty::Representation command.response_class = Google::Apis::TpuV1alpha1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::Location
Get information about a location.
70 71 72 73 74 75 76 77 78 |
# File 'generated/google/apis/tpu_v1alpha1/service.rb', line 70 def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha1/{+name}', ) command.response_representation = Google::Apis::TpuV1alpha1::Location::Representation command.response_class = Google::Apis::TpuV1alpha1::Location command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_node(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::Node
Gets the details of a node.
205 206 207 208 209 210 211 212 213 |
# File 'generated/google/apis/tpu_v1alpha1/service.rb', line 205 def get_project_location_node(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha1/{+name}', ) command.response_representation = Google::Apis::TpuV1alpha1::Node::Representation command.response_class = Google::Apis::TpuV1alpha1::Node command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::Operation
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
477 478 479 480 481 482 483 484 485 |
# File 'generated/google/apis/tpu_v1alpha1/service.rb', line 477 def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha1/{+name}', ) command.response_representation = Google::Apis::TpuV1alpha1::Operation::Representation command.response_class = Google::Apis::TpuV1alpha1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_tensorflow_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::TensorFlowVersion
Gets TensorFlow Version.
554 555 556 557 558 559 560 561 562 |
# File 'generated/google/apis/tpu_v1alpha1/service.rb', line 554 def get_project_location_tensorflow_version(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha1/{+name}', ) command.response_representation = Google::Apis::TpuV1alpha1::TensorFlowVersion::Representation command.response_class = Google::Apis::TpuV1alpha1::TensorFlowVersion command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_nodes(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::ListNodesResponse
Lists nodes.
239 240 241 242 243 244 245 246 247 248 249 |
# File 'generated/google/apis/tpu_v1alpha1/service.rb', line 239 def list_project_location_nodes(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha1/{+parent}/nodes', ) command.response_representation = Google::Apis::TpuV1alpha1::ListNodesResponse::Representation command.response_class = Google::Apis::TpuV1alpha1::ListNodesResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::ListOperationsResponse
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED.
NOTE: the name binding allows API services to override the binding
to use different resource name schemes, such as users/*/operations. To
override the binding, API services can add a binding such as
"/v1/name=users/*/operations" to their service configuration.
For backwards compatibility, the default name includes the operations
collection id, however overriding users must ensure the name binding
is the parent resource, without the operations collection id.
521 522 523 524 525 526 527 528 529 530 531 532 |
# File 'generated/google/apis/tpu_v1alpha1/service.rb', line 521 def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha1/{+name}/operations', ) command.response_representation = Google::Apis::TpuV1alpha1::ListOperationsResponse::Representation command.response_class = Google::Apis::TpuV1alpha1::ListOperationsResponse command.params['name'] = name unless name.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_tensorflow_versions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::ListTensorFlowVersionsResponse
Lists TensorFlow versions supported by this API.
592 593 594 595 596 597 598 599 600 601 602 603 604 |
# File 'generated/google/apis/tpu_v1alpha1/service.rb', line 592 def list_project_location_tensorflow_versions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha1/{+parent}/tensorflowVersions', ) command.response_representation = Google::Apis::TpuV1alpha1::ListTensorFlowVersionsResponse::Representation command.response_class = Google::Apis::TpuV1alpha1::ListTensorFlowVersionsResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::ListLocationsResponse
Lists information about the supported locations for this service.
106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'generated/google/apis/tpu_v1alpha1/service.rb', line 106 def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha1/{+name}/locations', ) command.response_representation = Google::Apis::TpuV1alpha1::ListLocationsResponse::Representation command.response_class = Google::Apis::TpuV1alpha1::ListLocationsResponse command.params['name'] = name unless name.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#reimage_project_location_node(name, reimage_node_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::Operation
Reimages a node's OS.
272 273 274 275 276 277 278 279 280 281 282 |
# File 'generated/google/apis/tpu_v1alpha1/service.rb', line 272 def reimage_project_location_node(name, reimage_node_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1alpha1/{+name}:reimage', ) command.request_representation = Google::Apis::TpuV1alpha1::ReimageNodeRequest::Representation command.request_object = reimage_node_request_object command.response_representation = Google::Apis::TpuV1alpha1::Operation::Representation command.response_class = Google::Apis::TpuV1alpha1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#reset_project_location_node(name, reset_node_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::Operation
Resets a node, which stops and starts the VM.
305 306 307 308 309 310 311 312 313 314 315 |
# File 'generated/google/apis/tpu_v1alpha1/service.rb', line 305 def reset_project_location_node(name, reset_node_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1alpha1/{+name}:reset', ) command.request_representation = Google::Apis::TpuV1alpha1::ResetNodeRequest::Representation command.request_object = reset_node_request_object command.response_representation = Google::Apis::TpuV1alpha1::Operation::Representation command.response_class = Google::Apis::TpuV1alpha1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#start_node(name, start_node_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::Operation
Starts a node.
338 339 340 341 342 343 344 345 346 347 348 |
# File 'generated/google/apis/tpu_v1alpha1/service.rb', line 338 def start_node(name, start_node_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1alpha1/{+name}:start', ) command.request_representation = Google::Apis::TpuV1alpha1::StartNodeRequest::Representation command.request_object = start_node_request_object command.response_representation = Google::Apis::TpuV1alpha1::Operation::Representation command.response_class = Google::Apis::TpuV1alpha1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#stop_node(name, stop_node_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TpuV1alpha1::Operation
Stops a node.
371 372 373 374 375 376 377 378 379 380 381 |
# File 'generated/google/apis/tpu_v1alpha1/service.rb', line 371 def stop_node(name, stop_node_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1alpha1/{+name}:stop', ) command.request_representation = Google::Apis::TpuV1alpha1::StopNodeRequest::Representation command.request_object = stop_node_request_object command.response_representation = Google::Apis::TpuV1alpha1::Operation::Representation command.response_class = Google::Apis::TpuV1alpha1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |