class Google::Apis::TpuV2alpha1::TPUService

Cloud TPU API

TPU API provides customers with access to Google TPU technology.

@example

require 'google/apis/tpu_v2alpha1'

Tpu = Google::Apis::TpuV2alpha1 # Alias the module
service = Tpu::TPUService.new

@see cloud.google.com/tpu/

Attributes

key[RW]

@return [String]

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.
quota_user[RW]

@return [String]

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.

Public Class Methods

new() click to toggle source
Calls superclass method
# File lib/google/apis/tpu_v2alpha1/service.rb, line 45
def initialize
  super('https://tpu.googleapis.com/', '',
        client_name: 'google-apis-tpu_v2alpha1',
        client_version: Google::Apis::TpuV2alpha1::GEM_VERSION)
  @batch_path = 'batch'
end

Public Instance Methods

cancel_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

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`. @param [String] name

The name of the operation resource to be cancelled.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TpuV2alpha1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TpuV2alpha1::Empty]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/tpu_v2alpha1/service.rb, line 531
def cancel_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha1/{+name}:cancel', options)
  command.response_representation = Google::Apis::TpuV2alpha1::Empty::Representation
  command.response_class = Google::Apis::TpuV2alpha1::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, request_id: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Creates a node. @param [String] parent

Required. The parent resource name.

@param [Google::Apis::TpuV2alpha1::Node] node_object @param [String] node_id

The unqualified resource name.

@param [String] request_id

Idempotent request UUID.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TpuV2alpha1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TpuV2alpha1::Operation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/tpu_v2alpha1/service.rb, line 255
def create_project_location_node(parent, node_object = nil, node_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha1/{+parent}/nodes', options)
  command.request_representation = Google::Apis::TpuV2alpha1::Node::Representation
  command.request_object = node_object
  command.response_representation = Google::Apis::TpuV2alpha1::Operation::Representation
  command.response_class = Google::Apis::TpuV2alpha1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['nodeId'] = node_id unless node_id.nil?
  command.query['requestId'] = request_id unless request_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, request_id: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes a node. @param [String] name

Required. The resource name.

@param [String] request_id

Idempotent request UUID.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TpuV2alpha1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TpuV2alpha1::Operation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/tpu_v2alpha1/service.rb, line 291
def delete_project_location_node(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2alpha1/{+name}', options)
  command.response_representation = Google::Apis::TpuV2alpha1::Operation::Representation
  command.response_class = Google::Apis::TpuV2alpha1::Operation
  command.params['name'] = name unless name.nil?
  command.query['requestId'] = request_id unless request_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_operation(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

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`. @param [String] name

The name of the operation resource to be deleted.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TpuV2alpha1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TpuV2alpha1::Empty]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/tpu_v2alpha1/service.rb, line 564
def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2alpha1/{+name}', options)
  command.response_representation = Google::Apis::TpuV2alpha1::Empty::Representation
  command.response_class = Google::Apis::TpuV2alpha1::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
generate_location_service_identity(parent, generate_service_identity_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Generates the Cloud TPU service identity for the project. @param [String] parent

Required. The parent resource name.

@param [Google::Apis::TpuV2alpha1::GenerateServiceIdentityRequest] generate_service_identity_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TpuV2alpha1::GenerateServiceIdentityResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TpuV2alpha1::GenerateServiceIdentityResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/tpu_v2alpha1/service.rb, line 73
def generate_location_service_identity(parent, generate_service_identity_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha1/{+parent}:generateServiceIdentity', options)
  command.request_representation = Google::Apis::TpuV2alpha1::GenerateServiceIdentityRequest::Representation
  command.request_object = generate_service_identity_request_object
  command.response_representation = Google::Apis::TpuV2alpha1::GenerateServiceIdentityResponse::Representation
  command.response_class = Google::Apis::TpuV2alpha1::GenerateServiceIdentityResponse
  command.params['parent'] = parent unless parent.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_node_guest_attributes(name, get_guest_attributes_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves the guest attributes for the node. @param [String] name

Required. The resource name.

@param [Google::Apis::TpuV2alpha1::GetGuestAttributesRequest] get_guest_attributes_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TpuV2alpha1::GetGuestAttributesResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TpuV2alpha1::GetGuestAttributesResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/tpu_v2alpha1/service.rb, line 353
def get_node_guest_attributes(name, get_guest_attributes_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha1/{+name}:getGuestAttributes', options)
  command.request_representation = Google::Apis::TpuV2alpha1::GetGuestAttributesRequest::Representation
  command.request_object = get_guest_attributes_request_object
  command.response_representation = Google::Apis::TpuV2alpha1::GetGuestAttributesResponse::Representation
  command.response_class = Google::Apis::TpuV2alpha1::GetGuestAttributesResponse
  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, &block) click to toggle source

Gets information about a location. @param [String] name

Resource name for the location.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TpuV2alpha1::Location] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TpuV2alpha1::Location]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/tpu_v2alpha1/service.rb, line 105
def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha1/{+name}', options)
  command.response_representation = Google::Apis::TpuV2alpha1::Location::Representation
  command.response_class = Google::Apis::TpuV2alpha1::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_accelerator_type(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Gets AcceleratorType. @param [String] name

Required. The resource name.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TpuV2alpha1::AcceleratorType] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TpuV2alpha1::AcceleratorType]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/tpu_v2alpha1/service.rb, line 178
def get_project_location_accelerator_type(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha1/{+name}', options)
  command.response_representation = Google::Apis::TpuV2alpha1::AcceleratorType::Representation
  command.response_class = Google::Apis::TpuV2alpha1::AcceleratorType
  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, &block) click to toggle source

Gets the details of a node. @param [String] name

Required. The resource name.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TpuV2alpha1::Node] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TpuV2alpha1::Node]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/tpu_v2alpha1/service.rb, line 322
def get_project_location_node(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha1/{+name}', options)
  command.response_representation = Google::Apis::TpuV2alpha1::Node::Representation
  command.response_class = Google::Apis::TpuV2alpha1::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, &block) click to toggle source

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. @param [String] name

The name of the operation resource.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TpuV2alpha1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TpuV2alpha1::Operation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/tpu_v2alpha1/service.rb, line 595
def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha1/{+name}', options)
  command.response_representation = Google::Apis::TpuV2alpha1::Operation::Representation
  command.response_class = Google::Apis::TpuV2alpha1::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_runtime_version(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Gets a runtime version. @param [String] name

Required. The resource name.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TpuV2alpha1::RuntimeVersion] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TpuV2alpha1::RuntimeVersion]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/tpu_v2alpha1/service.rb, line 671
def get_project_location_runtime_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha1/{+name}', options)
  command.response_representation = Google::Apis::TpuV2alpha1::RuntimeVersion::Representation
  command.response_class = Google::Apis::TpuV2alpha1::RuntimeVersion
  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_accelerator_types(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Lists accelerator types supported by this API. @param [String] parent

Required. The parent resource name.

@param [String] filter

List filter.

@param [String] order_by

Sort results.

@param [Fixnum] page_size

The maximum number of items to return.

@param [String] page_token

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TpuV2alpha1::ListAcceleratorTypesResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TpuV2alpha1::ListAcceleratorTypesResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/tpu_v2alpha1/service.rb, line 216
def list_project_location_accelerator_types(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, 'v2alpha1/{+parent}/acceleratorTypes', options)
  command.response_representation = Google::Apis::TpuV2alpha1::ListAcceleratorTypesResponse::Representation
  command.response_class = Google::Apis::TpuV2alpha1::ListAcceleratorTypesResponse
  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_location_nodes(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Lists nodes. @param [String] parent

Required. The parent resource name.

@param [Fixnum] page_size

The maximum number of items to return.

@param [String] page_token

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TpuV2alpha1::ListNodesResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TpuV2alpha1::ListNodesResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/tpu_v2alpha1/service.rb, line 389
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, 'v2alpha1/{+parent}/nodes', options)
  command.response_representation = Google::Apis::TpuV2alpha1::ListNodesResponse::Representation
  command.response_class = Google::Apis::TpuV2alpha1::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, &block) click to toggle source

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. @param [String] name

The name of the operation's parent resource.

@param [String] filter

The standard list filter.

@param [Fixnum] page_size

The standard list page size.

@param [String] page_token

The standard list page token.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TpuV2alpha1::ListOperationsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TpuV2alpha1::ListOperationsResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/tpu_v2alpha1/service.rb, line 638
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, 'v2alpha1/{+name}/operations', options)
  command.response_representation = Google::Apis::TpuV2alpha1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::TpuV2alpha1::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_runtime_versions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Lists runtime versions supported by this API. @param [String] parent

Required. The parent resource name.

@param [String] filter

List filter.

@param [String] order_by

Sort results.

@param [Fixnum] page_size

The maximum number of items to return.

@param [String] page_token

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TpuV2alpha1::ListRuntimeVersionsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TpuV2alpha1::ListRuntimeVersionsResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/tpu_v2alpha1/service.rb, line 709
def list_project_location_runtime_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, 'v2alpha1/{+parent}/runtimeVersions', options)
  command.response_representation = Google::Apis::TpuV2alpha1::ListRuntimeVersionsResponse::Representation
  command.response_class = Google::Apis::TpuV2alpha1::ListRuntimeVersionsResponse
  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, &block) click to toggle source

Lists information about the supported locations for this service. @param [String] name

The resource that owns the locations collection, if applicable.

@param [String] filter

A filter to narrow down results to a preferred subset. The filtering language
accepts strings like `"displayName=tokyo"`, and is documented in more detail
in [AIP-160](https://google.aip.dev/160).

@param [Fixnum] page_size

The maximum number of results to return. If not set, the service selects a
default.

@param [String] page_token

A page token received from the `next_page_token` field in the response. Send
that page token to receive the subsequent page.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TpuV2alpha1::ListLocationsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TpuV2alpha1::ListLocationsResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/tpu_v2alpha1/service.rb, line 145
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, 'v2alpha1/{+name}/locations', options)
  command.response_representation = Google::Apis::TpuV2alpha1::ListLocationsResponse::Representation
  command.response_class = Google::Apis::TpuV2alpha1::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
patch_project_location_node(name, node_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Updates the configurations of a node. @param [String] name

Output only. Immutable. The name of the TPU.

@param [Google::Apis::TpuV2alpha1::Node] node_object @param [String] update_mask

Required. Mask of fields from Node to update. Supported fields: [description,
tags, labels, metadata, network_config.enable_external_ips].

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TpuV2alpha1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TpuV2alpha1::Operation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/tpu_v2alpha1/service.rb, line 425
def patch_project_location_node(name, node_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2alpha1/{+name}', options)
  command.request_representation = Google::Apis::TpuV2alpha1::Node::Representation
  command.request_object = node_object
  command.response_representation = Google::Apis::TpuV2alpha1::Operation::Representation
  command.response_class = Google::Apis::TpuV2alpha1::Operation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.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, &block) click to toggle source

Starts a node. @param [String] name

The resource name.

@param [Google::Apis::TpuV2alpha1::StartNodeRequest] start_node_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TpuV2alpha1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TpuV2alpha1::Operation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/tpu_v2alpha1/service.rb, line 459
def start_node(name, start_node_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha1/{+name}:start', options)
  command.request_representation = Google::Apis::TpuV2alpha1::StartNodeRequest::Representation
  command.request_object = start_node_request_object
  command.response_representation = Google::Apis::TpuV2alpha1::Operation::Representation
  command.response_class = Google::Apis::TpuV2alpha1::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, &block) click to toggle source

Stops a node. This operation is only available with single TPU nodes. @param [String] name

The resource name.

@param [Google::Apis::TpuV2alpha1::StopNodeRequest] stop_node_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TpuV2alpha1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TpuV2alpha1::Operation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/tpu_v2alpha1/service.rb, line 492
def stop_node(name, stop_node_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha1/{+name}:stop', options)
  command.request_representation = Google::Apis::TpuV2alpha1::StopNodeRequest::Representation
  command.request_object = stop_node_request_object
  command.response_representation = Google::Apis::TpuV2alpha1::Operation::Representation
  command.response_class = Google::Apis::TpuV2alpha1::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

Protected Instance Methods

apply_command_defaults(command) click to toggle source
# File lib/google/apis/tpu_v2alpha1/service.rb, line 725
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
end