Class: Google::Apis::TpuV1::Node

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/tpu_v1/classes.rb,
lib/google/apis/tpu_v1/representations.rb,
lib/google/apis/tpu_v1/representations.rb

Overview

A TPU instance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Node

Returns a new instance of Node.



402
403
404
 
# File 'lib/google/apis/tpu_v1/classes.rb', line 402

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#accelerator_type ⇒ String

Required. The type of hardware accelerators associated with this node. Corresponds to the JSON property acceleratorType

Returns:

  • (String) 


289
290
291
 
# File 'lib/google/apis/tpu_v1/classes.rb', line 289

def accelerator_type
  @accelerator_type
end

#api_version ⇒ String

Output only. The API version that created this Node. Corresponds to the JSON property apiVersion

Returns:

  • (String) 


294
295
296
 
# File 'lib/google/apis/tpu_v1/classes.rb', line 294

def api_version
  @api_version
end

#cidr_block ⇒ String

The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. Corresponds to the JSON property cidrBlock

Returns:

  • (String) 


305
306
307
 
# File 'lib/google/apis/tpu_v1/classes.rb', line 305

def cidr_block
  @cidr_block
end

#create_time ⇒ String

Output only. The time when the node was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


310
311
312
 
# File 'lib/google/apis/tpu_v1/classes.rb', line 310

def create_time
  @create_time
end

#description ⇒ String

The user-supplied description of the TPU. Maximum of 512 characters. Corresponds to the JSON property description

Returns:

  • (String) 


315
316
317
 
# File 'lib/google/apis/tpu_v1/classes.rb', line 315

def description
  @description
end

#health ⇒ String

The health status of the TPU node. Corresponds to the JSON property health

Returns:

  • (String) 


320
321
322
 
# File 'lib/google/apis/tpu_v1/classes.rb', line 320

def health
  @health
end

#health_description ⇒ String

Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy. Corresponds to the JSON property healthDescription

Returns:

  • (String) 


326
327
328
 
# File 'lib/google/apis/tpu_v1/classes.rb', line 326

def health_description
  @health_description
end

#ip_address ⇒ String

Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances. Corresponds to the JSON property ipAddress

Returns:

  • (String) 


332
333
334
 
# File 'lib/google/apis/tpu_v1/classes.rb', line 332

def ip_address
  @ip_address
end

#labels ⇒ Hash<String,String>

Resource labels to represent user-provided metadata. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


337
338
339
 
# File 'lib/google/apis/tpu_v1/classes.rb', line 337

def labels
  @labels
end

#name ⇒ String

Output only. Immutable. The name of the TPU Corresponds to the JSON property name

Returns:

  • (String) 


342
343
344
 
# File 'lib/google/apis/tpu_v1/classes.rb', line 342

def name
  @name
end

#network ⇒ String

The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used. Corresponds to the JSON property network

Returns:

  • (String) 


349
350
351
 
# File 'lib/google/apis/tpu_v1/classes.rb', line 349

def network
  @network
end

#network_endpoints ⇒ Array<Google::Apis::TpuV1::NetworkEndpoint>

Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first. Corresponds to the JSON property networkEndpoints

Returns:



356
357
358
 
# File 'lib/google/apis/tpu_v1/classes.rb', line 356

def network_endpoints
  @network_endpoints
end

#port ⇒ String

Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances. Corresponds to the JSON property port

Returns:

  • (String) 


362
363
364
 
# File 'lib/google/apis/tpu_v1/classes.rb', line 362

def port
  @port
end

#scheduling_config ⇒ Google::Apis::TpuV1::SchedulingConfig

Sets the scheduling options for this node. Corresponds to the JSON property schedulingConfig

Returns:



367
368
369
 
# File 'lib/google/apis/tpu_v1/classes.rb', line 367

def scheduling_config
  @scheduling_config
end

#service_account ⇒ String

Output only. The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


375
376
377
 
# File 'lib/google/apis/tpu_v1/classes.rb', line 375

def 
  @service_account
end

#state ⇒ String

Output only. The current state for the TPU Node. Corresponds to the JSON property state

Returns:

  • (String) 


380
381
382
 
# File 'lib/google/apis/tpu_v1/classes.rb', line 380

def state
  @state
end

#symptoms ⇒ Array<Google::Apis::TpuV1::Symptom>

Output only. The Symptoms that have occurred to the TPU Node. Corresponds to the JSON property symptoms

Returns:



385
386
387
 
# File 'lib/google/apis/tpu_v1/classes.rb', line 385

def symptoms
  @symptoms
end

#tensorflow_version ⇒ String

Required. The version of Tensorflow running in the Node. Corresponds to the JSON property tensorflowVersion

Returns:

  • (String) 


390
391
392
 
# File 'lib/google/apis/tpu_v1/classes.rb', line 390

def tensorflow_version
  @tensorflow_version
end

#use_service_networking ⇒ Boolean Also known as: use_service_networking?

Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled. Corresponds to the JSON property useServiceNetworking

Returns:

  • (Boolean) 


399
400
401
 
# File 'lib/google/apis/tpu_v1/classes.rb', line 399

def use_service_networking
  @use_service_networking
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/google/apis/tpu_v1/classes.rb', line 407

def update!(**args)
  @accelerator_type = args[:accelerator_type] if args.key?(:accelerator_type)
  @api_version = args[:api_version] if args.key?(:api_version)
  @cidr_block = args[:cidr_block] if args.key?(:cidr_block)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @health = args[:health] if args.key?(:health)
  @health_description = args[:health_description] if args.key?(:health_description)
  @ip_address = args[:ip_address] if args.key?(:ip_address)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @network_endpoints = args[:network_endpoints] if args.key?(:network_endpoints)
  @port = args[:port] if args.key?(:port)
  @scheduling_config = args[:scheduling_config] if args.key?(:scheduling_config)
  @service_account = args[:service_account] if args.key?(:service_account)
  @state = args[:state] if args.key?(:state)
  @symptoms = args[:symptoms] if args.key?(:symptoms)
  @tensorflow_version = args[:tensorflow_version] if args.key?(:tensorflow_version)
  @use_service_networking = args[:use_service_networking] if args.key?(:use_service_networking)
end