/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/tpu/v2alpha1/cloud_tpu.proto
package com.google.cloud.tpu.v2alpha1;
public interface NodeOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.tpu.v2alpha1.Node)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Output only. Immutable. The name of the TPU.
*
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
*
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Output only. Immutable. The name of the TPU.
*
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
*
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* The user-supplied description of the TPU. Maximum of 512 characters.
*
*
* string description = 3;
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* The user-supplied description of the TPU. Maximum of 512 characters.
*
*
* string description = 3;
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* The type of hardware accelerators associated with this node.
*
*
* string accelerator_type = 5;
*
* @return The acceleratorType.
*/
java.lang.String getAcceleratorType();
/**
*
*
*
* The type of hardware accelerators associated with this node.
*
*
* string accelerator_type = 5;
*
* @return The bytes for acceleratorType.
*/
com.google.protobuf.ByteString getAcceleratorTypeBytes();
/**
*
*
*
* Output only. The current state for the TPU Node.
*
*
*
* .google.cloud.tpu.v2alpha1.Node.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Output only. The current state for the TPU Node.
*
*
*
* .google.cloud.tpu.v2alpha1.Node.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The state.
*/
com.google.cloud.tpu.v2alpha1.Node.State getState();
/**
*
*
*
* 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];
*
* @return The healthDescription.
*/
java.lang.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];
*
* @return The bytes for healthDescription.
*/
com.google.protobuf.ByteString getHealthDescriptionBytes();
/**
*
*
*
* Required. The runtime version running in the Node.
*
*
* string runtime_version = 11 [(.google.api.field_behavior) = REQUIRED];
*
* @return The runtimeVersion.
*/
java.lang.String getRuntimeVersion();
/**
*
*
*
* Required. The runtime version running in the Node.
*
*
* string runtime_version = 11 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for runtimeVersion.
*/
com.google.protobuf.ByteString getRuntimeVersionBytes();
/**
*
*
*
* Network configurations for the TPU node.
*
*
* .google.cloud.tpu.v2alpha1.NetworkConfig network_config = 36;
*
* @return Whether the networkConfig field is set.
*/
boolean hasNetworkConfig();
/**
*
*
*
* Network configurations for the TPU node.
*
*
* .google.cloud.tpu.v2alpha1.NetworkConfig network_config = 36;
*
* @return The networkConfig.
*/
com.google.cloud.tpu.v2alpha1.NetworkConfig getNetworkConfig();
/**
*
*
*
* Network configurations for the TPU node.
*
*
* .google.cloud.tpu.v2alpha1.NetworkConfig network_config = 36;
*/
com.google.cloud.tpu.v2alpha1.NetworkConfigOrBuilder getNetworkConfigOrBuilder();
/**
*
*
*
* 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;
*
* @return The cidrBlock.
*/
java.lang.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;
*
* @return The bytes for cidrBlock.
*/
com.google.protobuf.ByteString getCidrBlockBytes();
/**
*
*
*
* 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.v2alpha1.ServiceAccount service_account = 37;
*
* @return Whether the serviceAccount field is set.
*/
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.v2alpha1.ServiceAccount service_account = 37;
*
* @return The serviceAccount.
*/
com.google.cloud.tpu.v2alpha1.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.v2alpha1.ServiceAccount service_account = 37;
*/
com.google.cloud.tpu.v2alpha1.ServiceAccountOrBuilder getServiceAccountOrBuilder();
/**
*
*
*
* Output only. The time when the node was created.
*
*
* .google.protobuf.Timestamp create_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The time when the node was created.
*
*
* .google.protobuf.Timestamp create_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* The scheduling options for this node.
*
*
* .google.cloud.tpu.v2alpha1.SchedulingConfig scheduling_config = 17;
*
* @return Whether the schedulingConfig field is set.
*/
boolean hasSchedulingConfig();
/**
*
*
*
* The scheduling options for this node.
*
*
* .google.cloud.tpu.v2alpha1.SchedulingConfig scheduling_config = 17;
*
* @return The schedulingConfig.
*/
com.google.cloud.tpu.v2alpha1.SchedulingConfig getSchedulingConfig();
/**
*
*
*
* The scheduling options for this node.
*
*
* .google.cloud.tpu.v2alpha1.SchedulingConfig scheduling_config = 17;
*/
com.google.cloud.tpu.v2alpha1.SchedulingConfigOrBuilder getSchedulingConfigOrBuilder();
/**
*
*
*
* 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.v2alpha1.NetworkEndpoint network_endpoints = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.util.List 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.v2alpha1.NetworkEndpoint network_endpoints = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.tpu.v2alpha1.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.v2alpha1.NetworkEndpoint network_endpoints = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
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.v2alpha1.NetworkEndpoint network_endpoints = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.util.List
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.v2alpha1.NetworkEndpoint network_endpoints = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.tpu.v2alpha1.NetworkEndpointOrBuilder getNetworkEndpointsOrBuilder(int index);
/**
*
*
*
* The health status of the TPU node.
*
*
* .google.cloud.tpu.v2alpha1.Node.Health health = 22;
*
* @return The enum numeric value on the wire for health.
*/
int getHealthValue();
/**
*
*
*
* The health status of the TPU node.
*
*
* .google.cloud.tpu.v2alpha1.Node.Health health = 22;
*
* @return The health.
*/
com.google.cloud.tpu.v2alpha1.Node.Health getHealth();
/**
*
*
*
* Resource labels to represent user-provided metadata.
*
*
* map<string, string> labels = 24;
*/
int getLabelsCount();
/**
*
*
*
* Resource labels to represent user-provided metadata.
*
*
* map<string, string> labels = 24;
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* Resource labels to represent user-provided metadata.
*
*
* map<string, string> labels = 24;
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Resource labels to represent user-provided metadata.
*
*
* map<string, string> labels = 24;
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Resource labels to represent user-provided metadata.
*
*
* map<string, string> labels = 24;
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Custom metadata to apply to the TPU Node.
* Can set startup-script and shutdown-script
*
*
* map<string, string> metadata = 34;
*/
int getMetadataCount();
/**
*
*
*
* Custom metadata to apply to the TPU Node.
* Can set startup-script and shutdown-script
*
*
* map<string, string> metadata = 34;
*/
boolean containsMetadata(java.lang.String key);
/** Use {@link #getMetadataMap()} instead. */
@java.lang.Deprecated
java.util.Map getMetadata();
/**
*
*
*
* Custom metadata to apply to the TPU Node.
* Can set startup-script and shutdown-script
*
*
* map<string, string> metadata = 34;
*/
java.util.Map getMetadataMap();
/**
*
*
*
* Custom metadata to apply to the TPU Node.
* Can set startup-script and shutdown-script
*
*
* map<string, string> metadata = 34;
*/
/* nullable */
java.lang.String getMetadataOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Custom metadata to apply to the TPU Node.
* Can set startup-script and shutdown-script
*
*
* map<string, string> metadata = 34;
*/
java.lang.String getMetadataOrThrow(java.lang.String key);
/**
*
*
*
* Tags to apply to the TPU Node. Tags are used to identify valid sources or
* targets for network firewalls.
*
*
* repeated string tags = 40;
*
* @return A list containing the tags.
*/
java.util.List getTagsList();
/**
*
*
*
* Tags to apply to the TPU Node. Tags are used to identify valid sources or
* targets for network firewalls.
*
*
* repeated string tags = 40;
*
* @return The count of tags.
*/
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;
*
* @param index The index of the element to return.
* @return The tags at the given index.
*/
java.lang.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;
*
* @param index The index of the value to return.
* @return The bytes of the tags at the given index.
*/
com.google.protobuf.ByteString getTagsBytes(int index);
/**
*
*
*
* Output only. The unique identifier for the TPU Node.
*
*
* int64 id = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The id.
*/
long getId();
/**
*
*
*
* The additional data disks for the Node.
*
*
* repeated .google.cloud.tpu.v2alpha1.AttachedDisk data_disks = 41;
*/
java.util.List getDataDisksList();
/**
*
*
*
* The additional data disks for the Node.
*
*
* repeated .google.cloud.tpu.v2alpha1.AttachedDisk data_disks = 41;
*/
com.google.cloud.tpu.v2alpha1.AttachedDisk getDataDisks(int index);
/**
*
*
*
* The additional data disks for the Node.
*
*
* repeated .google.cloud.tpu.v2alpha1.AttachedDisk data_disks = 41;
*/
int getDataDisksCount();
/**
*
*
*
* The additional data disks for the Node.
*
*
* repeated .google.cloud.tpu.v2alpha1.AttachedDisk data_disks = 41;
*/
java.util.List
getDataDisksOrBuilderList();
/**
*
*
*
* The additional data disks for the Node.
*
*
* repeated .google.cloud.tpu.v2alpha1.AttachedDisk data_disks = 41;
*/
com.google.cloud.tpu.v2alpha1.AttachedDiskOrBuilder getDataDisksOrBuilder(int index);
/**
*
*
*
* Output only. The API version that created this Node.
*
*
*
* .google.cloud.tpu.v2alpha1.Node.ApiVersion api_version = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for apiVersion.
*/
int getApiVersionValue();
/**
*
*
*
* Output only. The API version that created this Node.
*
*
*
* .google.cloud.tpu.v2alpha1.Node.ApiVersion api_version = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The apiVersion.
*/
com.google.cloud.tpu.v2alpha1.Node.ApiVersion getApiVersion();
/**
*
*
*
* Output only. The Symptoms that have occurred to the TPU Node.
*
*
*
* repeated .google.cloud.tpu.v2alpha1.Symptom symptoms = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.util.List getSymptomsList();
/**
*
*
*
* Output only. The Symptoms that have occurred to the TPU Node.
*
*
*
* repeated .google.cloud.tpu.v2alpha1.Symptom symptoms = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.tpu.v2alpha1.Symptom getSymptoms(int index);
/**
*
*
*
* Output only. The Symptoms that have occurred to the TPU Node.
*
*
*
* repeated .google.cloud.tpu.v2alpha1.Symptom symptoms = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
int getSymptomsCount();
/**
*
*
*
* Output only. The Symptoms that have occurred to the TPU Node.
*
*
*
* repeated .google.cloud.tpu.v2alpha1.Symptom symptoms = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.util.List
getSymptomsOrBuilderList();
/**
*
*
*
* Output only. The Symptoms that have occurred to the TPU Node.
*
*
*
* repeated .google.cloud.tpu.v2alpha1.Symptom symptoms = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.tpu.v2alpha1.SymptomOrBuilder getSymptomsOrBuilder(int index);
/**
*
*
*
* Output only. The qualified name of the QueuedResource that requested this
* Node.
*
*
* string queued_resource = 43 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The queuedResource.
*/
java.lang.String getQueuedResource();
/**
*
*
*
* Output only. The qualified name of the QueuedResource that requested this
* Node.
*
*
* string queued_resource = 43 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for queuedResource.
*/
com.google.protobuf.ByteString getQueuedResourceBytes();
/**
*
*
*
* The AccleratorConfig for the TPU Node.
*
*
* .google.cloud.tpu.v2alpha1.AcceleratorConfig accelerator_config = 44;
*
* @return Whether the acceleratorConfig field is set.
*/
boolean hasAcceleratorConfig();
/**
*
*
*
* The AccleratorConfig for the TPU Node.
*
*
* .google.cloud.tpu.v2alpha1.AcceleratorConfig accelerator_config = 44;
*
* @return The acceleratorConfig.
*/
com.google.cloud.tpu.v2alpha1.AcceleratorConfig getAcceleratorConfig();
/**
*
*
*
* The AccleratorConfig for the TPU Node.
*
*
* .google.cloud.tpu.v2alpha1.AcceleratorConfig accelerator_config = 44;
*/
com.google.cloud.tpu.v2alpha1.AcceleratorConfigOrBuilder getAcceleratorConfigOrBuilder();
/**
*
*
*
* Shielded Instance options.
*
*
* .google.cloud.tpu.v2alpha1.ShieldedInstanceConfig shielded_instance_config = 45;
*
* @return Whether the shieldedInstanceConfig field is set.
*/
boolean hasShieldedInstanceConfig();
/**
*
*
*
* Shielded Instance options.
*
*
* .google.cloud.tpu.v2alpha1.ShieldedInstanceConfig shielded_instance_config = 45;
*
* @return The shieldedInstanceConfig.
*/
com.google.cloud.tpu.v2alpha1.ShieldedInstanceConfig getShieldedInstanceConfig();
/**
*
*
*
* Shielded Instance options.
*
*
* .google.cloud.tpu.v2alpha1.ShieldedInstanceConfig shielded_instance_config = 45;
*/
com.google.cloud.tpu.v2alpha1.ShieldedInstanceConfigOrBuilder
getShieldedInstanceConfigOrBuilder();
}