Package com.google.cloud.tpu.v1

Class Node

  • All Implemented Interfaces:
    NodeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Node
extends com.google.protobuf.GeneratedMessageV3
implements NodeOrBuilder
     A TPU instance.
    Protobuf type google.cloud.tpu.v1.Node
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

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

      • getNameBytes

        public 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];
        Specified by:
        getNameBytes in interface NodeOrBuilder
        Returns:
        The bytes for name.

      • getDescription

        public String getDescription()
         The user-supplied description of the TPU. Maximum of 512 characters.
        string description = 3;
        Specified by:
        getDescription in interface NodeOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

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

      • getAcceleratorType

        public String getAcceleratorType()
         Required. The type of hardware accelerators associated with this node.
        string accelerator_type = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getAcceleratorType in interface NodeOrBuilder
        Returns:
        The acceleratorType.

      • getAcceleratorTypeBytes

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

      • getIpAddress

        @Deprecated
public 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];
        Specified by:
        getIpAddress in interface NodeOrBuilder
        Returns:
        The ipAddress.

      • getIpAddressBytes

        @Deprecated
public 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];
        Specified by:
        getIpAddressBytes in interface NodeOrBuilder
        Returns:
        The bytes for ipAddress.

      • getPort

        @Deprecated
public 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];
        Specified by:
        getPort in interface NodeOrBuilder
        Returns:
        The port.

      • getPortBytes

        @Deprecated
public 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];
        Specified by:
        getPortBytes in interface NodeOrBuilder
        Returns:
        The bytes for port.

      • getStateValue

        public 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];
        Specified by:
        getStateValue in interface NodeOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public 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];
        Specified by:
        getState in interface NodeOrBuilder
        Returns:
        The state.

      • getHealthDescription

        public 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];
        Specified by:
        getHealthDescription in interface NodeOrBuilder
        Returns:
        The healthDescription.

      • getHealthDescriptionBytes

        public 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];
        Specified by:
        getHealthDescriptionBytes in interface NodeOrBuilder
        Returns:
        The bytes for healthDescription.

      • getTensorflowVersion

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

      • getTensorflowVersionBytes

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

      • getNetwork

        public 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;
        Specified by:
        getNetwork in interface NodeOrBuilder
        Returns:
        The network.

      • getNetworkBytes

        public 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;
        Specified by:
        getNetworkBytes in interface NodeOrBuilder
        Returns:
        The bytes for network.

      • getCidrBlock

        public 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;
        Specified by:
        getCidrBlock in interface NodeOrBuilder
        Returns:
        The cidrBlock.

      • getCidrBlockBytes

        public 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;
        Specified by:
        getCidrBlockBytes in interface NodeOrBuilder
        Returns:
        The bytes for cidrBlock.

      • getServiceAccount

        public 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];
        Specified by:
        getServiceAccount in interface NodeOrBuilder
        Returns:
        The serviceAccount.

      • getServiceAccountBytes

        public 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];
        Specified by:
        getServiceAccountBytes in interface NodeOrBuilder
        Returns:
        The bytes for serviceAccount.

      • hasCreateTime

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

      • getCreateTime

        public 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];
        Specified by:
        getCreateTime in interface NodeOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public 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];
        Specified by:
        getCreateTimeOrBuilder in interface NodeOrBuilder

      • hasSchedulingConfig

        public boolean hasSchedulingConfig()
         The scheduling options for this node.
        .google.cloud.tpu.v1.SchedulingConfig scheduling_config = 17;
        Specified by:
        hasSchedulingConfig in interface NodeOrBuilder
        Returns:
        Whether the schedulingConfig field is set.

      • getSchedulingConfig

        public SchedulingConfig getSchedulingConfig()
         The scheduling options for this node.
        .google.cloud.tpu.v1.SchedulingConfig scheduling_config = 17;
        Specified by:
        getSchedulingConfig in interface NodeOrBuilder
        Returns:
        The schedulingConfig.

      • getNetworkEndpointsList

        public 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];
        Specified by:
        getNetworkEndpointsList in interface NodeOrBuilder

      • getNetworkEndpointsOrBuilderList

        public 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];
        Specified by:
        getNetworkEndpointsOrBuilderList in interface NodeOrBuilder

      • getNetworkEndpointsCount

        public 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];
        Specified by:
        getNetworkEndpointsCount in interface NodeOrBuilder

      • getNetworkEndpoints

        public 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];
        Specified by:
        getNetworkEndpoints in interface NodeOrBuilder

      • getNetworkEndpointsOrBuilder

        public 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];
        Specified by:
        getNetworkEndpointsOrBuilder in interface NodeOrBuilder

      • getHealthValue

        public int getHealthValue()
         The health status of the TPU node.
        .google.cloud.tpu.v1.Node.Health health = 22;
        Specified by:
        getHealthValue in interface NodeOrBuilder
        Returns:
        The enum numeric value on the wire for health.

      • getHealth

        public Node.Health getHealth()
         The health status of the TPU node.
        .google.cloud.tpu.v1.Node.Health health = 22;
        Specified by:
        getHealth in interface NodeOrBuilder
        Returns:
        The health.

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: NodeOrBuilder
         Resource labels to represent user-provided metadata.
        map<string, string> labels = 24;
        Specified by:
        getLabelsCount in interface NodeOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         Resource labels to represent user-provided metadata.
        map<string, string> labels = 24;
        Specified by:
        containsLabels in interface NodeOrBuilder

      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         Resource labels to represent user-provided metadata.
        map<string, string> labels = 24;
        Specified by:
        getLabelsMap in interface NodeOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         Resource labels to represent user-provided metadata.
        map<string, string> labels = 24;
        Specified by:
        getLabelsOrThrow in interface NodeOrBuilder

      • getUseServiceNetworking

        public 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;
        Specified by:
        getUseServiceNetworking in interface NodeOrBuilder
        Returns:
        The useServiceNetworking.

      • getApiVersionValue

        public 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];
        Specified by:
        getApiVersionValue in interface NodeOrBuilder
        Returns:
        The enum numeric value on the wire for apiVersion.

      • getApiVersion

        public 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];
        Specified by:
        getApiVersion in interface NodeOrBuilder
        Returns:
        The apiVersion.

      • getSymptomsList

        public 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];
        Specified by:
        getSymptomsList in interface NodeOrBuilder

      • getSymptomsOrBuilderList

        public 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];
        Specified by:
        getSymptomsOrBuilderList in interface NodeOrBuilder

      • getSymptomsCount

        public 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];
        Specified by:
        getSymptomsCount in interface NodeOrBuilder

      • getSymptoms

        public 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];
        Specified by:
        getSymptoms in interface NodeOrBuilder

      • getSymptomsOrBuilder

        public 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];
        Specified by:
        getSymptomsOrBuilder in interface NodeOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Node parseFrom​(ByteBuffer data)
                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Node parseFrom​(ByteBuffer data,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Node parseFrom​(com.google.protobuf.ByteString data)
                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Node parseFrom​(com.google.protobuf.ByteString data,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Node parseFrom​(byte[] data)
                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Node parseFrom​(byte[] data,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Node parseFrom​(com.google.protobuf.CodedInputStream input,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Node.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Node.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Node.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Node getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Node> parser()

      • getParserForType

        public com.google.protobuf.Parser<Node> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Node getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder