Package com.google.cloud.tpu.v1

Interface NodeOrBuilder

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

    • Method Detail

      • getName

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

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Output only. Immutable. The name of the TPU
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
        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()
         Required. The type of hardware accelerators associated with this node.
        string accelerator_type = 5 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The acceleratorType.

      • getAcceleratorTypeBytes

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

      • getIpAddress

        @Deprecated
String getIpAddress()
        Deprecated.
        google.cloud.tpu.v1.Node.ip_address is deprecated. See google/cloud/tpu/v1/cloud_tpu.proto;l=279
         Output only. DEPRECATED! Use network_endpoints instead.
 The network address for the TPU Node as visible to Compute Engine
 instances.
        string ip_address = 8 [deprecated = true];
        Returns:
        The ipAddress.

      • getIpAddressBytes

        @Deprecated
com.google.protobuf.ByteString getIpAddressBytes()
        Deprecated.
        google.cloud.tpu.v1.Node.ip_address is deprecated. See google/cloud/tpu/v1/cloud_tpu.proto;l=279
         Output only. DEPRECATED! Use network_endpoints instead.
 The network address for the TPU Node as visible to Compute Engine
 instances.
        string ip_address = 8 [deprecated = true];
        Returns:
        The bytes for ipAddress.

      • getPort

        @Deprecated
String getPort()
        Deprecated.
        google.cloud.tpu.v1.Node.port is deprecated. See google/cloud/tpu/v1/cloud_tpu.proto;l=283
         Output only. DEPRECATED! Use network_endpoints instead.
 The network port for the TPU Node as visible to Compute Engine instances.
        string port = 14 [deprecated = true];
        Returns:
        The port.

      • getPortBytes

        @Deprecated
com.google.protobuf.ByteString getPortBytes()
        Deprecated.
        google.cloud.tpu.v1.Node.port is deprecated. See google/cloud/tpu/v1/cloud_tpu.proto;l=283
         Output only. DEPRECATED! Use network_endpoints instead.
 The network port for the TPU Node as visible to Compute Engine instances.
        string port = 14 [deprecated = true];
        Returns:
        The bytes for port.

      • getStateValue

        int getStateValue()
         Output only. The current state for the TPU Node.
        .google.cloud.tpu.v1.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.v1.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.

      • getTensorflowVersion

        String getTensorflowVersion()
         Required. The version of Tensorflow running in the Node.
        string tensorflow_version = 11 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The tensorflowVersion.

      • getTensorflowVersionBytes

        com.google.protobuf.ByteString getTensorflowVersionBytes()
         Required. The version of Tensorflow running in the Node.
        string tensorflow_version = 11 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for tensorflowVersion.

      • getNetwork

        String getNetwork()
         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.
        string network = 12;
        Returns:
        The network.

      • getNetworkBytes

        com.google.protobuf.ByteString getNetworkBytes()
         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.
        string network = 12;
        Returns:
        The bytes for network.

      • 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.

      • getServiceAccount

        String getServiceAccount()
         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.
        string service_account = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The serviceAccount.

      • getServiceAccountBytes

        com.google.protobuf.ByteString getServiceAccountBytes()
         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.
        string service_account = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for serviceAccount.

      • 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.v1.SchedulingConfig scheduling_config = 17;
        Returns:
        Whether the schedulingConfig field is set.

      • getSchedulingConfig

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

      • getSchedulingConfigOrBuilder

        SchedulingConfigOrBuilder getSchedulingConfigOrBuilder()
         The scheduling options for this node.
        .google.cloud.tpu.v1.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 Tensorflow clients of the node reach out
 to the 0th entry in this map first.
        repeated .google.cloud.tpu.v1.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 Tensorflow clients of the node reach out
 to the 0th entry in this map first.
        repeated .google.cloud.tpu.v1.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 Tensorflow clients of the node reach out
 to the 0th entry in this map first.
        repeated .google.cloud.tpu.v1.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 Tensorflow clients of the node reach out
 to the 0th entry in this map first.
        repeated .google.cloud.tpu.v1.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 Tensorflow clients of the node reach out
 to the 0th entry in this map first.
        repeated .google.cloud.tpu.v1.NetworkEndpoint network_endpoints = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getHealthValue

        int getHealthValue()
         The health status of the TPU node.
        .google.cloud.tpu.v1.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.v1.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;

      • 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;

      • getUseServiceNetworking

        boolean getUseServiceNetworking()
         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.
        bool use_service_networking = 27;
        Returns:
        The useServiceNetworking.

      • getApiVersionValue

        int getApiVersionValue()
         Output only. The API version that created this Node.
        .google.cloud.tpu.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.Symptom symptoms = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];