Class: Google::Apis::TpuV2alpha1::Node

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/tpu_v2alpha1/classes.rb,
lib/google/apis/tpu_v2alpha1/representations.rb,
lib/google/apis/tpu_v2alpha1/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.



1018
1019
1020
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 1018

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

Instance Attribute Details

#accelerator_config ⇒ Google::Apis::TpuV2alpha1::AcceleratorConfig

A TPU accelerator configuration. Corresponds to the JSON property acceleratorConfig

Returns:



865
866
867
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 865

def accelerator_config
  @accelerator_config
end

#accelerator_type ⇒ String

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

Returns:

  • (String) 


870
871
872
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 870

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) 


875
876
877
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 875

def api_version
  @api_version
end

#autocheckpoint_enabled ⇒ Boolean Also known as: autocheckpoint_enabled?

Optional. Whether Autocheckpoint is enabled. Corresponds to the JSON property autocheckpointEnabled

Returns:

  • (Boolean) 


880
881
882
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 880

def autocheckpoint_enabled
  @autocheckpoint_enabled
end

#boot_disk_config ⇒ Google::Apis::TpuV2alpha1::BootDiskConfig

Boot disk configurations. Corresponds to the JSON property bootDiskConfig

Returns:



886
887
888
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 886

def boot_disk_config
  @boot_disk_config
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) 


897
898
899
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 897

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) 


902
903
904
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 902

def create_time
  @create_time
end

#data_disks ⇒ Array<Google::Apis::TpuV2alpha1::AttachedDisk>

The additional data disks for the Node. Corresponds to the JSON property dataDisks

Returns:



907
908
909
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 907

def data_disks
  @data_disks
end

#description ⇒ String

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

Returns:

  • (String) 


912
913
914
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 912

def description
  @description
end

#health ⇒ String

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

Returns:

  • (String) 


917
918
919
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 917

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) 


923
924
925
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 923

def health_description
  @health_description
end

#id ⇒ Fixnum

Output only. The unique identifier for the TPU Node. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


928
929
930
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 928

def id
  @id
end

#labels ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


933
934
935
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 933

def labels
  @labels
end

#metadata ⇒ Hash<String,String>

Custom metadata to apply to the TPU Node. Can set startup-script and shutdown- script Corresponds to the JSON property metadata

Returns:

  • (Hash<String,String>) 


939
940
941
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 939

def metadata
  @metadata
end

#multislice_node ⇒ Boolean Also known as: multislice_node?

Output only. Whether the Node belongs to a Multislice group. Corresponds to the JSON property multisliceNode

Returns:

  • (Boolean) 


944
945
946
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 944

def multislice_node
  @multislice_node
end

#name ⇒ String

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

Returns:

  • (String) 


950
951
952
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 950

def name
  @name
end

#network_config ⇒ Google::Apis::TpuV2alpha1::NetworkConfig

Network related configurations. Corresponds to the JSON property networkConfig

Returns:



955
956
957
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 955

def network_config
  @network_config
end

#network_configs ⇒ Array<Google::Apis::TpuV2alpha1::NetworkConfig>

Optional. Repeated network configurations for the TPU node. This field is used to specify multiple networks configs for the TPU node. network_config and network_configs are mutually exclusive, you can only specify one of them. If both are specified, an error will be returned. Corresponds to the JSON property networkConfigs

Returns:



963
964
965
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 963

def network_configs
  @network_configs
end

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

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

Returns:



970
971
972
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 970

def network_endpoints
  @network_endpoints
end

#queued_resource ⇒ String

Output only. The qualified name of the QueuedResource that requested this Node. Corresponds to the JSON property queuedResource

Returns:

  • (String) 


975
976
977
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 975

def queued_resource
  @queued_resource
end

#runtime_version ⇒ String

Required. The runtime version running in the Node. Corresponds to the JSON property runtimeVersion

Returns:

  • (String) 


980
981
982
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 980

def runtime_version
  @runtime_version
end

#scheduling_config ⇒ Google::Apis::TpuV2alpha1::SchedulingConfig

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

Returns:



985
986
987
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 985

def scheduling_config
  @scheduling_config
end

#service_account ⇒ Google::Apis::TpuV2alpha1::ServiceAccount

A service account. Corresponds to the JSON property serviceAccount

Returns:



990
991
992
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 990

def 
  @service_account
end

#shielded_instance_config ⇒ Google::Apis::TpuV2alpha1::ShieldedInstanceConfig

A set of Shielded Instance options. Corresponds to the JSON property shieldedInstanceConfig

Returns:



995
996
997
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 995

def shielded_instance_config
  @shielded_instance_config
end

#state ⇒ String

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

Returns:

  • (String) 


1000
1001
1002
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 1000

def state
  @state
end

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

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

Returns:



1005
1006
1007
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 1005

def symptoms
  @symptoms
end

#tags ⇒ Array<String>

Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls. Corresponds to the JSON property tags

Returns:

  • (Array<String>) 


1011
1012
1013
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 1011

def tags
  @tags
end

#upcoming_maintenance ⇒ Google::Apis::TpuV2alpha1::UpcomingMaintenance

Upcoming Maintenance notification information. Corresponds to the JSON property upcomingMaintenance

Returns:



1016
1017
1018
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 1016

def upcoming_maintenance
  @upcoming_maintenance
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
 
# File 'lib/google/apis/tpu_v2alpha1/classes.rb', line 1023

def update!(**args)
  @accelerator_config = args[:accelerator_config] if args.key?(:accelerator_config)
  @accelerator_type = args[:accelerator_type] if args.key?(:accelerator_type)
  @api_version = args[:api_version] if args.key?(:api_version)
  @autocheckpoint_enabled = args[:autocheckpoint_enabled] if args.key?(:autocheckpoint_enabled)
  @boot_disk_config = args[:boot_disk_config] if args.key?(:boot_disk_config)
  @cidr_block = args[:cidr_block] if args.key?(:cidr_block)
  @create_time = args[:create_time] if args.key?(:create_time)
  @data_disks = args[:data_disks] if args.key?(:data_disks)
  @description = args[:description] if args.key?(:description)
  @health = args[:health] if args.key?(:health)
  @health_description = args[:health_description] if args.key?(:health_description)
  @id = args[:id] if args.key?(:id)
  @labels = args[:labels] if args.key?(:labels)
  @metadata = args[:metadata] if args.key?(:metadata)
  @multislice_node = args[:multislice_node] if args.key?(:multislice_node)
  @name = args[:name] if args.key?(:name)
  @network_config = args[:network_config] if args.key?(:network_config)
  @network_configs = args[:network_configs] if args.key?(:network_configs)
  @network_endpoints = args[:network_endpoints] if args.key?(:network_endpoints)
  @queued_resource = args[:queued_resource] if args.key?(:queued_resource)
  @runtime_version = args[:runtime_version] if args.key?(:runtime_version)
  @scheduling_config = args[:scheduling_config] if args.key?(:scheduling_config)
  @service_account = args[:service_account] if args.key?(:service_account)
  @shielded_instance_config = args[:shielded_instance_config] if args.key?(:shielded_instance_config)
  @state = args[:state] if args.key?(:state)
  @symptoms = args[:symptoms] if args.key?(:symptoms)
  @tags = args[:tags] if args.key?(:tags)
  @upcoming_maintenance = args[:upcoming_maintenance] if args.key?(:upcoming_maintenance)
end