public final class Node extends GeneratedMessageV3 implements NodeOrBuilder
A TPU instance.
Protobuf type google.cloud.tpu.v1.Node
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
ACCELERATOR_TYPE_FIELD_NUMBER
public static final int ACCELERATOR_TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
API_VERSION_FIELD_NUMBER
public static final int API_VERSION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CIDR_BLOCK_FIELD_NUMBER
public static final int CIDR_BLOCK_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
HEALTH_DESCRIPTION_FIELD_NUMBER
public static final int HEALTH_DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
HEALTH_FIELD_NUMBER
public static final int HEALTH_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
IP_ADDRESS_FIELD_NUMBER
public static final int IP_ADDRESS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NETWORK_ENDPOINTS_FIELD_NUMBER
public static final int NETWORK_ENDPOINTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PORT_FIELD_NUMBER
public static final int PORT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SCHEDULING_CONFIG_FIELD_NUMBER
public static final int SCHEDULING_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SERVICE_ACCOUNT_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SYMPTOMS_FIELD_NUMBER
public static final int SYMPTOMS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TENSORFLOW_VERSION_FIELD_NUMBER
public static final int TENSORFLOW_VERSION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
USE_SERVICE_NETWORKING_FIELD_NUMBER
public static final int USE_SERVICE_NETWORKING_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Node getDefaultInstance()
| Returns |
|---|
| Type | Description |
Node | |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Node.Builder newBuilder()
newBuilder(Node prototype)
public static Node.Builder newBuilder(Node prototype)
| Parameter |
|---|
| Name | Description |
prototype | Node
|
public static Node parseDelimitedFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Node | |
public static Node parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Node | |
parseFrom(byte[] data)
public static Node parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
| Returns |
|---|
| Type | Description |
Node | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Node parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Node | |
parseFrom(ByteString data)
public static Node parseFrom(ByteString data)
| Returns |
|---|
| Type | Description |
Node | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Node parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Node | |
public static Node parseFrom(CodedInputStream input)
| Returns |
|---|
| Type | Description |
Node | |
public static Node parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Node | |
public static Node parseFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Node | |
public static Node parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Node | |
parseFrom(ByteBuffer data)
public static Node parseFrom(ByteBuffer data)
| Returns |
|---|
| Type | Description |
Node | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Node parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Node | |
parser()
public static Parser<Node> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Resource labels to represent user-provided metadata.
map<string, string> labels = 24;
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAcceleratorType()
public String getAcceleratorType()
Required. The type of hardware accelerators associated with this node.
string accelerator_type = 5 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
String | The acceleratorType.
|
getAcceleratorTypeBytes()
public ByteString getAcceleratorTypeBytes()
Required. The type of hardware accelerators associated with this node.
string accelerator_type = 5 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for acceleratorType.
|
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];
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];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for apiVersion.
|
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;
| Returns |
|---|
| Type | Description |
String | The cidrBlock.
|
getCidrBlockBytes()
public 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 |
|---|
| Type | Description |
ByteString | The bytes for cidrBlock.
|
getCreateTime()
public Timestamp getCreateTime()
Output only. The time when the node was created.
.google.protobuf.Timestamp create_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time when the node was created.
.google.protobuf.Timestamp create_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Node getDefaultInstanceForType()
| Returns |
|---|
| Type | Description |
Node | |
getDescription()
public String getDescription()
The user-supplied description of the TPU. Maximum of 512 characters.
string description = 3;
| Returns |
|---|
| Type | Description |
String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
The user-supplied description of the TPU. Maximum of 512 characters.
string description = 3;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for description.
|
getHealth()
public Node.Health getHealth()
The health status of the TPU node.
.google.cloud.tpu.v1.Node.Health health = 22;
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];
| Returns |
|---|
| Type | Description |
String | The healthDescription.
|
getHealthDescriptionBytes()
public 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 |
|---|
| Type | Description |
ByteString | The bytes for healthDescription.
|
getHealthValue()
public int getHealthValue()
The health status of the TPU node.
.google.cloud.tpu.v1.Node.Health health = 22;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for health.
|
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];
| Returns |
|---|
| Type | Description |
String | The ipAddress.
|
getIpAddressBytes() (deprecated)
public 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 |
|---|
| Type | Description |
ByteString | The bytes for ipAddress.
|
getLabels()
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
Resource labels to represent user-provided metadata.
map<string, string> labels = 24;
| Returns |
|---|
| Type | Description |
int | |
getLabelsMap()
public Map<String,String> getLabelsMap()
Resource labels to represent user-provided metadata.
map<string, string> labels = 24;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Resource labels to represent user-provided metadata.
map<string, string> labels = 24;
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Resource labels to represent user-provided metadata.
map<string, string> labels = 24;
| Parameter |
|---|
| Name | Description |
key | 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 |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public 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 |
|---|
| Type | Description |
ByteString | The bytes for name.
|
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;
| Returns |
|---|
| Type | Description |
String | The network.
|
getNetworkBytes()
public 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 |
|---|
| Type | Description |
ByteString | The bytes for network.
|
getNetworkEndpoints(int index)
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];
| Parameter |
|---|
| Name | Description |
index | int
|
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];
| Returns |
|---|
| Type | Description |
int | |
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];
getNetworkEndpointsOrBuilder(int index)
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];
| Parameter |
|---|
| Name | Description |
index | int
|
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];
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.tpu.v1.NetworkEndpointOrBuilder> | |
getParserForType()
public Parser<Node> getParserForType()
Overrides
getPort() (deprecated)
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 |
|---|
| Type | Description |
String | The port.
|
getPortBytes() (deprecated)
public 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 |
|---|
| Type | Description |
ByteString | The bytes for port.
|
getSchedulingConfig()
public SchedulingConfig getSchedulingConfig()
The scheduling options for this node.
.google.cloud.tpu.v1.SchedulingConfig scheduling_config = 17;
getSchedulingConfigOrBuilder()
public SchedulingConfigOrBuilder getSchedulingConfigOrBuilder()
The scheduling options for this node.
.google.cloud.tpu.v1.SchedulingConfig scheduling_config = 17;
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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];
| Returns |
|---|
| Type | Description |
String | The serviceAccount.
|
getServiceAccountBytes()
public 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 |
|---|
| Type | Description |
ByteString | The bytes for serviceAccount.
|
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];
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];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for state.
|
getSymptoms(int index)
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];
| Parameter |
|---|
| Name | Description |
index | int
|
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];
| Returns |
|---|
| Type | Description |
int | |
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];
getSymptomsOrBuilder(int index)
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];
| Parameter |
|---|
| Name | Description |
index | int
|
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];
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.tpu.v1.SymptomOrBuilder> | |
getTensorflowVersion()
public String getTensorflowVersion()
Required. The version of Tensorflow running in the Node.
string tensorflow_version = 11 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
String | The tensorflowVersion.
|
getTensorflowVersionBytes()
public ByteString getTensorflowVersionBytes()
Required. The version of Tensorflow running in the Node.
string tensorflow_version = 11 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for tensorflowVersion.
|
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;
| Returns |
|---|
| Type | Description |
boolean | The useServiceNetworking.
|
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];
| Returns |
|---|
| Type | Description |
boolean | Whether the createTime field is set.
|
hasSchedulingConfig()
public boolean hasSchedulingConfig()
The scheduling options for this node.
.google.cloud.tpu.v1.SchedulingConfig scheduling_config = 17;
| Returns |
|---|
| Type | Description |
boolean | Whether the schedulingConfig field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Node.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Node.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Node.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
