public
final
class
Node
extends
GeneratedMessageV3
implements
NodeOrBuilder
A TPU instance.
Protobuf type google.cloud.tpu.v1.Node
Static Fields
ACCELERATOR_TYPE_FIELD_NUMBER
public
static
final
int
ACCELERATOR_TYPE_FIELD_NUMBER
Field Value
API_VERSION_FIELD_NUMBER
public
static
final
int
API_VERSION_FIELD_NUMBER
Field Value
CIDR_BLOCK_FIELD_NUMBER
public
static
final
int
CIDR_BLOCK_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public
static
final
int
CREATE_TIME_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public
static
final
int
DESCRIPTION_FIELD_NUMBER
Field Value
HEALTH_DESCRIPTION_FIELD_NUMBER
public
static
final
int
HEALTH_DESCRIPTION_FIELD_NUMBER
Field Value
HEALTH_FIELD_NUMBER
public
static
final
int
HEALTH_FIELD_NUMBER
Field Value
IP_ADDRESS_FIELD_NUMBER
public
static
final
int
IP_ADDRESS_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public
static
final
int
LABELS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public
static
final
int
NAME_FIELD_NUMBER
Field Value
NETWORK_ENDPOINTS_FIELD_NUMBER
public
static
final
int
NETWORK_ENDPOINTS_FIELD_NUMBER
Field Value
NETWORK_FIELD_NUMBER
public
static
final
int
NETWORK_FIELD_NUMBER
Field Value
PORT_FIELD_NUMBER
public
static
final
int
PORT_FIELD_NUMBER
Field Value
SCHEDULING_CONFIG_FIELD_NUMBER
public
static
final
int
SCHEDULING_CONFIG_FIELD_NUMBER
Field Value
SERVICE_ACCOUNT_FIELD_NUMBER
public
static
final
int
SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public
static
final
int
STATE_FIELD_NUMBER
Field Value
SYMPTOMS_FIELD_NUMBER
public
static
final
int
SYMPTOMS_FIELD_NUMBER
Field Value
TENSORFLOW_VERSION_FIELD_NUMBER
public
static
final
int
TENSORFLOW_VERSION_FIELD_NUMBER
Field Value
USE_SERVICE_NETWORKING_FIELD_NUMBER
public
static
final
int
USE_SERVICE_NETWORKING_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public
static
Node
getDefaultInstance
()
Returns
getDescriptor()
public
static
final
Descriptors
.
Descriptor
getDescriptor
()
Returns
newBuilder()
public
static
Node
.
Builder
newBuilder
()
Returns
newBuilder(Node prototype)
public
static
Node
.
Builder
newBuilder
(
Node
prototype
)
Parameter
Returns
public
static
Node
parseDelimitedFrom
(
InputStream
input
)
Parameter
Returns
Exceptions
public
static
Node
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public
static
Node
parseFrom
(
byte
[]
data
)
Parameter
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
Node
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public
static
Node
parseFrom
(
ByteString
data
)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
Node
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
public
static
Node
parseFrom
(
CodedInputStream
input
)
Parameter
Returns
Exceptions
public
static
Node
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
public
static
Node
parseFrom
(
InputStream
input
)
Parameter
Returns
Exceptions
public
static
Node
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public
static
Node
parseFrom
(
ByteBuffer
data
)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
Node
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parser()
public
static
Parser<Node>
parser
()
Returns
Methods
containsLabels(String key)
public
boolean
containsLabels
(
String
key
)
Resource labels to represent user-provided metadata.
map<string, string> labels = 24;
Parameter
Returns
equals(Object obj)
public
boolean
equals
(
Object
obj
)
Parameter
Returns
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
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];
Returns
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
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
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
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];
Returns
getDefaultInstanceForType()
public
Node
getDefaultInstanceForType
()
Returns
getDescription()
public
String
getDescription
()
The user-supplied description of the TPU. Maximum of 512 characters.
string description = 3;
Returns
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;
Returns
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
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=275
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
getIpAddressBytes() (deprecated)
public
ByteString
getIpAddressBytes
()
Deprecated. google.cloud.tpu.v1.Node.ip_address is deprecated. See
google/cloud/tpu/v1/cloud_tpu.proto;l=275
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
getLabels()
public
Map<String
,
String
>
getLabels
()
Returns
getLabelsCount()
public
int
getLabelsCount
()
Resource labels to represent user-provided metadata.
map<string, string> labels = 24;
Returns
getLabelsMap()
public
Map<String
,
String
>
getLabelsMap
()
Resource labels to represent user-provided metadata.
map<string, string> labels = 24;
Returns
getLabelsOrDefault(String key, String defaultValue)
public
String
getLabelsOrDefault
(
String
key
,
String
defaultValue
)
Resource labels to represent user-provided metadata.
map<string, string> labels = 24;
Parameters
Returns
getLabelsOrThrow(String key)
public
String
getLabelsOrThrow
(
String
key
)
Resource labels to represent user-provided metadata.
map<string, string> labels = 24;
Parameter
Returns
getName()
Output only. Immutable. The name of the TPU
string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
Returns
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
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
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
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
Returns
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
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];
Returns
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
Returns
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
getParserForType()
public
Parser<Node>
getParserForType
()
Returns
Overrides
getPort() (deprecated)
Deprecated. google.cloud.tpu.v1.Node.port is deprecated. See
google/cloud/tpu/v1/cloud_tpu.proto;l=279
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
getPortBytes() (deprecated)
public
ByteString
getPortBytes
()
Deprecated. google.cloud.tpu.v1.Node.port is deprecated. See
google/cloud/tpu/v1/cloud_tpu.proto;l=279
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
getSchedulingConfig()
public
SchedulingConfig
getSchedulingConfig
()
The scheduling options for this node.
.google.cloud.tpu.v1.SchedulingConfig scheduling_config = 17;
Returns
getSchedulingConfigOrBuilder()
public
SchedulingConfigOrBuilder
getSchedulingConfigOrBuilder
()
The scheduling options for this node.
.google.cloud.tpu.v1.SchedulingConfig scheduling_config = 17;
Returns
getSerializedSize()
public
int
getSerializedSize
()
Returns
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
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];
Returns
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
Returns
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
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];
Returns
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
Returns
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
getTensorflowVersion()
public
String
getTensorflowVersion
()
Required. The version of Tensorflow running in the Node.
string tensorflow_version = 11 [(.google.api.field_behavior) = REQUIRED];
Returns
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.
|
getUnknownFields()
public
final
UnknownFieldSet
getUnknownFields
()
Returns
Overrides
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
Overrides
internalGetFieldAccessorTable()
protected
GeneratedMessageV3
.
FieldAccessorTable
internalGetFieldAccessorTable
()
Returns
Overrides
internalGetMapField(int number)
protected
MapField
internalGetMapField
(
int
number
)
Parameter
Returns
Overrides
isInitialized()
public
final
boolean
isInitialized
()
Returns
Overrides
newBuilderForType()
public
Node
.
Builder
newBuilderForType
()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected
Node
.
Builder
newBuilderForType
(
GeneratedMessageV3
.
BuilderParent
parent
)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected
Object
newInstance
(
GeneratedMessageV3
.
UnusedPrivateParameter
unused
)
Parameter
Returns
Overrides
toBuilder()
public
Node
.
Builder
toBuilder
()
Returns
writeTo(CodedOutputStream output)
public
void
writeTo
(
CodedOutputStream
output
)
Parameter
Overrides
Exceptions
