Package com.google.cloud.tpu.v2

Interface NodeOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Node, Node.Builder
@Generated public interface NodeOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Output only. Immutable. The name of the TPU.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Output only. Immutable. The name of the TPU.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The bytes for name.

    • getDescription

      String getDescription()
       The user-supplied description of the TPU. Maximum of 512 characters.
      string description = 3;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       The user-supplied description of the TPU. Maximum of 512 characters.
      string description = 3;
      Returns:
      The bytes for description.

    • getAcceleratorType

      String getAcceleratorType()
       Optional. The type of hardware accelerators associated with this node.
      string accelerator_type = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The acceleratorType.

    • getAcceleratorTypeBytes

      com.google.protobuf.ByteString getAcceleratorTypeBytes()
       Optional. The type of hardware accelerators associated with this node.
      string accelerator_type = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for acceleratorType.

    • getStateValue

      int getStateValue()
       Output only. The current state for the TPU Node.
      .google.cloud.tpu.v2.Node.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      Node.State getState()
       Output only. The current state for the TPU Node.
      .google.cloud.tpu.v2.Node.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.

    • getHealthDescription

      String getHealthDescription()
       Output only. If this field is populated, it contains a description of why
 the TPU Node is unhealthy.
      string health_description = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The healthDescription.

    • getHealthDescriptionBytes

      com.google.protobuf.ByteString getHealthDescriptionBytes()
       Output only. If this field is populated, it contains a description of why
 the TPU Node is unhealthy.
      string health_description = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for healthDescription.

    • getRuntimeVersion

      String getRuntimeVersion()
       Required. The runtime version running in the Node.
      string runtime_version = 11 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The runtimeVersion.

    • getRuntimeVersionBytes

      com.google.protobuf.ByteString getRuntimeVersionBytes()
       Required. The runtime version running in the Node.
      string runtime_version = 11 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for runtimeVersion.

    • hasNetworkConfig

      boolean hasNetworkConfig()
       Network configurations 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.
      .google.cloud.tpu.v2.NetworkConfig network_config = 36;
      Returns:
      Whether the networkConfig field is set.

    • getNetworkConfig

      NetworkConfig getNetworkConfig()
       Network configurations 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.
      .google.cloud.tpu.v2.NetworkConfig network_config = 36;
      Returns:
      The networkConfig.

    • getNetworkConfigOrBuilder

      NetworkConfigOrBuilder getNetworkConfigOrBuilder()
       Network configurations 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.
      .google.cloud.tpu.v2.NetworkConfig network_config = 36;

    • getNetworkConfigsList

      List<NetworkConfig> getNetworkConfigsList()
       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.
      repeated .google.cloud.tpu.v2.NetworkConfig network_configs = 49 [(.google.api.field_behavior) = OPTIONAL];

    • getNetworkConfigs

      NetworkConfig getNetworkConfigs(int index)
       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.
      repeated .google.cloud.tpu.v2.NetworkConfig network_configs = 49 [(.google.api.field_behavior) = OPTIONAL];

    • getNetworkConfigsCount

      int getNetworkConfigsCount()
       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.
      repeated .google.cloud.tpu.v2.NetworkConfig network_configs = 49 [(.google.api.field_behavior) = OPTIONAL];

    • getNetworkConfigsOrBuilderList

      List<? extends NetworkConfigOrBuilder> getNetworkConfigsOrBuilderList()
       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.
      repeated .google.cloud.tpu.v2.NetworkConfig network_configs = 49 [(.google.api.field_behavior) = OPTIONAL];

    • getNetworkConfigsOrBuilder

      NetworkConfigOrBuilder getNetworkConfigsOrBuilder(int index)
       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.
      repeated .google.cloud.tpu.v2.NetworkConfig network_configs = 49 [(.google.api.field_behavior) = OPTIONAL];

    • getCidrBlock

      String getCidrBlock()
       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.
      string cidr_block = 13;
      Returns:
      The cidrBlock.

    • getCidrBlockBytes

      com.google.protobuf.ByteString getCidrBlockBytes()
       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.
      string cidr_block = 13;
      Returns:
      The bytes for cidrBlock.

    • hasServiceAccount

      boolean hasServiceAccount()
       The Google Cloud Platform Service Account to be used by the TPU node VMs.
 If None is specified, the default compute service account will be used.
      .google.cloud.tpu.v2.ServiceAccount service_account = 37;
      Returns:
      Whether the serviceAccount field is set.

    • getServiceAccount

      ServiceAccount getServiceAccount()
       The Google Cloud Platform Service Account to be used by the TPU node VMs.
 If None is specified, the default compute service account will be used.
      .google.cloud.tpu.v2.ServiceAccount service_account = 37;
      Returns:
      The serviceAccount.

    • getServiceAccountOrBuilder

      ServiceAccountOrBuilder getServiceAccountOrBuilder()
       The Google Cloud Platform Service Account to be used by the TPU node VMs.
 If None is specified, the default compute service account will be used.
      .google.cloud.tpu.v2.ServiceAccount service_account = 37;

    • hasCreateTime

      boolean hasCreateTime()
       Output only. The time when the node was created.
      .google.protobuf.Timestamp create_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. The time when the node was created.
      .google.protobuf.Timestamp create_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The time when the node was created.
      .google.protobuf.Timestamp create_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasSchedulingConfig

      boolean hasSchedulingConfig()
       The scheduling options for this node.
      .google.cloud.tpu.v2.SchedulingConfig scheduling_config = 17;
      Returns:
      Whether the schedulingConfig field is set.

    • getSchedulingConfig

      SchedulingConfig getSchedulingConfig()
       The scheduling options for this node.
      .google.cloud.tpu.v2.SchedulingConfig scheduling_config = 17;
      Returns:
      The schedulingConfig.

    • getSchedulingConfigOrBuilder

      SchedulingConfigOrBuilder getSchedulingConfigOrBuilder()
       The scheduling options for this node.
      .google.cloud.tpu.v2.SchedulingConfig scheduling_config = 17;

    • getNetworkEndpointsList

      List<NetworkEndpoint> getNetworkEndpointsList()
       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.
      repeated .google.cloud.tpu.v2.NetworkEndpoint network_endpoints = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getNetworkEndpoints

      NetworkEndpoint getNetworkEndpoints(int index)
       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.
      repeated .google.cloud.tpu.v2.NetworkEndpoint network_endpoints = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getNetworkEndpointsCount

      int getNetworkEndpointsCount()
       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.
      repeated .google.cloud.tpu.v2.NetworkEndpoint network_endpoints = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getNetworkEndpointsOrBuilderList

      List<? extends NetworkEndpointOrBuilder> getNetworkEndpointsOrBuilderList()
       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.
      repeated .google.cloud.tpu.v2.NetworkEndpoint network_endpoints = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getNetworkEndpointsOrBuilder

      NetworkEndpointOrBuilder getNetworkEndpointsOrBuilder(int index)
       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.
      repeated .google.cloud.tpu.v2.NetworkEndpoint network_endpoints = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getHealthValue

      int getHealthValue()
       The health status of the TPU node.
      .google.cloud.tpu.v2.Node.Health health = 22;
      Returns:
      The enum numeric value on the wire for health.

    • getHealth

      Node.Health getHealth()
       The health status of the TPU node.
      .google.cloud.tpu.v2.Node.Health health = 22;
      Returns:
      The health.

    • getLabelsCount

      int getLabelsCount()
       Resource labels to represent user-provided metadata.
      map<string, string> labels = 24;

    • containsLabels

      boolean containsLabels(String key)
       Resource labels to represent user-provided metadata.
      map<string, string> labels = 24;

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       Resource labels to represent user-provided metadata.
      map<string, string> labels = 24;

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       Resource labels to represent user-provided metadata.
      map<string, string> labels = 24;

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       Resource labels to represent user-provided metadata.
      map<string, string> labels = 24;

    • getMetadataCount

      int getMetadataCount()
       Custom metadata to apply to the TPU Node.
 Can set startup-script and shutdown-script
      map<string, string> metadata = 34;

    • containsMetadata

      boolean containsMetadata(String key)
       Custom metadata to apply to the TPU Node.
 Can set startup-script and shutdown-script
      map<string, string> metadata = 34;

    • getMetadata

      @Deprecated Map<String,String> getMetadata()
      Deprecated.
      Use getMetadataMap() instead.

    • getMetadataMap

      Map<String,String> getMetadataMap()
       Custom metadata to apply to the TPU Node.
 Can set startup-script and shutdown-script
      map<string, string> metadata = 34;

    • getMetadataOrDefault

      String getMetadataOrDefault(String key, String defaultValue)
       Custom metadata to apply to the TPU Node.
 Can set startup-script and shutdown-script
      map<string, string> metadata = 34;

    • getMetadataOrThrow

      String getMetadataOrThrow(String key)
       Custom metadata to apply to the TPU Node.
 Can set startup-script and shutdown-script
      map<string, string> metadata = 34;

    • getTagsList

      List<String> getTagsList()
       Tags to apply to the TPU Node. Tags are used to identify valid sources or
 targets for network firewalls.
      repeated string tags = 40;
      Returns:
      A list containing the tags.

    • getTagsCount

      int getTagsCount()
       Tags to apply to the TPU Node. Tags are used to identify valid sources or
 targets for network firewalls.
      repeated string tags = 40;
      Returns:
      The count of tags.

    • getTags

      String getTags(int index)
       Tags to apply to the TPU Node. Tags are used to identify valid sources or
 targets for network firewalls.
      repeated string tags = 40;
      Parameters:
      index - The index of the element to return.
      Returns:
      The tags at the given index.

    • getTagsBytes

      com.google.protobuf.ByteString getTagsBytes(int index)
       Tags to apply to the TPU Node. Tags are used to identify valid sources or
 targets for network firewalls.
      repeated string tags = 40;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the tags at the given index.

    • getId

      long getId()
       Output only. The unique identifier for the TPU Node.
      int64 id = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The id.

    • getDataDisksList

      List<AttachedDisk> getDataDisksList()
       The additional data disks for the Node.
      repeated .google.cloud.tpu.v2.AttachedDisk data_disks = 41;

    • getDataDisks

      AttachedDisk getDataDisks(int index)
       The additional data disks for the Node.
      repeated .google.cloud.tpu.v2.AttachedDisk data_disks = 41;

    • getDataDisksCount

      int getDataDisksCount()
       The additional data disks for the Node.
      repeated .google.cloud.tpu.v2.AttachedDisk data_disks = 41;

    • getDataDisksOrBuilderList

      List<? extends AttachedDiskOrBuilder> getDataDisksOrBuilderList()
       The additional data disks for the Node.
      repeated .google.cloud.tpu.v2.AttachedDisk data_disks = 41;

    • getDataDisksOrBuilder

      AttachedDiskOrBuilder getDataDisksOrBuilder(int index)
       The additional data disks for the Node.
      repeated .google.cloud.tpu.v2.AttachedDisk data_disks = 41;

    • getApiVersionValue

      int getApiVersionValue()
       Output only. The API version that created this Node.
      .google.cloud.tpu.v2.Node.ApiVersion api_version = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for apiVersion.

    • getApiVersion

      Node.ApiVersion getApiVersion()
       Output only. The API version that created this Node.
      .google.cloud.tpu.v2.Node.ApiVersion api_version = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The apiVersion.

    • getSymptomsList

      List<Symptom> getSymptomsList()
       Output only. The Symptoms that have occurred to the TPU Node.
      repeated .google.cloud.tpu.v2.Symptom symptoms = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getSymptoms

      Symptom getSymptoms(int index)
       Output only. The Symptoms that have occurred to the TPU Node.
      repeated .google.cloud.tpu.v2.Symptom symptoms = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getSymptomsCount

      int getSymptomsCount()
       Output only. The Symptoms that have occurred to the TPU Node.
      repeated .google.cloud.tpu.v2.Symptom symptoms = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getSymptomsOrBuilderList

      List<? extends SymptomOrBuilder> getSymptomsOrBuilderList()
       Output only. The Symptoms that have occurred to the TPU Node.
      repeated .google.cloud.tpu.v2.Symptom symptoms = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getSymptomsOrBuilder

      SymptomOrBuilder getSymptomsOrBuilder(int index)
       Output only. The Symptoms that have occurred to the TPU Node.
      repeated .google.cloud.tpu.v2.Symptom symptoms = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasShieldedInstanceConfig

      boolean hasShieldedInstanceConfig()
       Shielded Instance options.
      .google.cloud.tpu.v2.ShieldedInstanceConfig shielded_instance_config = 45;
      Returns:
      Whether the shieldedInstanceConfig field is set.

    • getShieldedInstanceConfig

      ShieldedInstanceConfig getShieldedInstanceConfig()
       Shielded Instance options.
      .google.cloud.tpu.v2.ShieldedInstanceConfig shielded_instance_config = 45;
      Returns:
      The shieldedInstanceConfig.

    • getShieldedInstanceConfigOrBuilder

      ShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()
       Shielded Instance options.
      .google.cloud.tpu.v2.ShieldedInstanceConfig shielded_instance_config = 45;

    • hasAcceleratorConfig

      boolean hasAcceleratorConfig()
       The AccleratorConfig for the TPU Node.
      .google.cloud.tpu.v2.AcceleratorConfig accelerator_config = 46;
      Returns:
      Whether the acceleratorConfig field is set.

    • getAcceleratorConfig

      AcceleratorConfig getAcceleratorConfig()
       The AccleratorConfig for the TPU Node.
      .google.cloud.tpu.v2.AcceleratorConfig accelerator_config = 46;
      Returns:
      The acceleratorConfig.

    • getAcceleratorConfigOrBuilder

      AcceleratorConfigOrBuilder getAcceleratorConfigOrBuilder()
       The AccleratorConfig for the TPU Node.
      .google.cloud.tpu.v2.AcceleratorConfig accelerator_config = 46;

    • getQueuedResource

      String getQueuedResource()
       Output only. The qualified name of the QueuedResource that requested this
 Node.
      string queued_resource = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The queuedResource.

    • getQueuedResourceBytes

      com.google.protobuf.ByteString getQueuedResourceBytes()
       Output only. The qualified name of the QueuedResource that requested this
 Node.
      string queued_resource = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for queuedResource.

    • getMultisliceNode

      boolean getMultisliceNode()
       Output only. Whether the Node belongs to a Multislice group.
      bool multislice_node = 48 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The multisliceNode.