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

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

Overview

A TPU instance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Node

Returns a new instance of Node



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

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

Instance Attribute Details

#accelerator_typeString

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

Returns:

  • (String)


280
281
282
# File 'generated/google/apis/tpu_v1/classes.rb', line 280

def accelerator_type
  @accelerator_type
end

#cidr_blockString

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. Required. Corresponds to the JSON property cidrBlock

Returns:

  • (String)


293
294
295
# File 'generated/google/apis/tpu_v1/classes.rb', line 293

def cidr_block
  @cidr_block
end

#create_timeString

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

Returns:

  • (String)


299
300
301
# File 'generated/google/apis/tpu_v1/classes.rb', line 299

def create_time
  @create_time
end

#descriptionString

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

Returns:

  • (String)


304
305
306
# File 'generated/google/apis/tpu_v1/classes.rb', line 304

def description
  @description
end

#healthString

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

Returns:

  • (String)


309
310
311
# File 'generated/google/apis/tpu_v1/classes.rb', line 309

def health
  @health
end

#health_descriptionString

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)


316
317
318
# File 'generated/google/apis/tpu_v1/classes.rb', line 316

def health_description
  @health_description
end

#ip_addressString

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)


324
325
326
# File 'generated/google/apis/tpu_v1/classes.rb', line 324

def ip_address
  @ip_address
end

#labelsHash<String,String>

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

Returns:

  • (Hash<String,String>)


329
330
331
# File 'generated/google/apis/tpu_v1/classes.rb', line 329

def labels
  @labels
end

#nameString

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

Returns:

  • (String)


335
336
337
# File 'generated/google/apis/tpu_v1/classes.rb', line 335

def name
  @name
end

#networkString

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)


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

def network
  @network
end

#network_endpointsArray<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



350
351
352
# File 'generated/google/apis/tpu_v1/classes.rb', line 350

def network_endpoints
  @network_endpoints
end

#portString

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)


357
358
359
# File 'generated/google/apis/tpu_v1/classes.rb', line 357

def port
  @port
end

#scheduling_configGoogle::Apis::TpuV1::SchedulingConfig

Corresponds to the JSON property schedulingConfig



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

def scheduling_config
  @scheduling_config
end

#service_accountString

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)


371
372
373
# File 'generated/google/apis/tpu_v1/classes.rb', line 371

def 
  @service_account
end

#stateString

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

Returns:

  • (String)


377
378
379
# File 'generated/google/apis/tpu_v1/classes.rb', line 377

def state
  @state
end

#tensorflow_versionString

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

Returns:

  • (String)


383
384
385
# File 'generated/google/apis/tpu_v1/classes.rb', line 383

def tensorflow_version
  @tensorflow_version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'generated/google/apis/tpu_v1/classes.rb', line 390

def update!(**args)
  @accelerator_type = args[:accelerator_type] if args.key?(:accelerator_type)
  @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)
  @tensorflow_version = args[:tensorflow_version] if args.key?(:tensorflow_version)
end