Package com.google.cloud.hypercomputecluster.v1

Class SlurmLoginNodes

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.hypercomputecluster.v1.SlurmLoginNodes
All Implemented Interfaces:
SlurmLoginNodesOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SlurmLoginNodes extends com.google.protobuf.GeneratedMessage implements SlurmLoginNodesOrBuilder
 Configuration for Slurm [login
 nodes](https://slurm.schedmd.com/quickstart_admin.html#login) in the cluster.
 Login nodes are Compute Engine VM instances that allow users to access the
 cluster over SSH.
Protobuf type google.cloud.hypercomputecluster.v1.SlurmLoginNodes
See Also:

  • Field Details

    • COUNT_FIELD_NUMBER

      public static final int COUNT_FIELD_NUMBER
      See Also:

    • ZONE_FIELD_NUMBER

      public static final int ZONE_FIELD_NUMBER
      See Also:

    • MACHINE_TYPE_FIELD_NUMBER

      public static final int MACHINE_TYPE_FIELD_NUMBER
      See Also:

    • STARTUP_SCRIPT_FIELD_NUMBER

      public static final int STARTUP_SCRIPT_FIELD_NUMBER
      See Also:

    • ENABLE_OS_LOGIN_FIELD_NUMBER

      public static final int ENABLE_OS_LOGIN_FIELD_NUMBER
      See Also:

    • ENABLE_PUBLIC_IPS_FIELD_NUMBER

      public static final int ENABLE_PUBLIC_IPS_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • STORAGE_CONFIGS_FIELD_NUMBER

      public static final int STORAGE_CONFIGS_FIELD_NUMBER
      See Also:

    • INSTANCES_FIELD_NUMBER

      public static final int INSTANCES_FIELD_NUMBER
      See Also:

    • BOOT_DISK_FIELD_NUMBER

      public static final int BOOT_DISK_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • getCount

      public long getCount()
       Required. Number of login node instances to create.
      int64 count = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCount in interface SlurmLoginNodesOrBuilder
      Returns:
      The count.

    • getZone

      public String getZone()
       Required. Name of the zone in which login nodes should run, e.g.,
 `us-central1-a`. Must be in the same region as the cluster, and must match
 the zone of any other resources specified in the cluster.
      string zone = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getZone in interface SlurmLoginNodesOrBuilder
      Returns:
      The zone.

    • getZoneBytes

      public com.google.protobuf.ByteString getZoneBytes()
       Required. Name of the zone in which login nodes should run, e.g.,
 `us-central1-a`. Must be in the same region as the cluster, and must match
 the zone of any other resources specified in the cluster.
      string zone = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getZoneBytes in interface SlurmLoginNodesOrBuilder
      Returns:
      The bytes for zone.

    • getMachineType

      public String getMachineType()
       Required. Name of the Compute Engine [machine
 type](https://cloud.google.com/compute/docs/machine-resource) to use for
 login nodes, e.g. `n2-standard-2`.
      string machine_type = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getMachineType in interface SlurmLoginNodesOrBuilder
      Returns:
      The machineType.

    • getMachineTypeBytes

      public com.google.protobuf.ByteString getMachineTypeBytes()
       Required. Name of the Compute Engine [machine
 type](https://cloud.google.com/compute/docs/machine-resource) to use for
 login nodes, e.g. `n2-standard-2`.
      string machine_type = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getMachineTypeBytes in interface SlurmLoginNodesOrBuilder
      Returns:
      The bytes for machineType.

    • getStartupScript

      public String getStartupScript()
       Optional. [Startup
 script](https://cloud.google.com/compute/docs/instances/startup-scripts/linux)
 to be run on each login node instance. Max 256KB.
 The script must complete within the system-defined default timeout of 5
 minutes. For tasks that require more time, consider running them in the
 background using methods such as `&` or `nohup`.
      string startup_script = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getStartupScript in interface SlurmLoginNodesOrBuilder
      Returns:
      The startupScript.

    • getStartupScriptBytes

      public com.google.protobuf.ByteString getStartupScriptBytes()
       Optional. [Startup
 script](https://cloud.google.com/compute/docs/instances/startup-scripts/linux)
 to be run on each login node instance. Max 256KB.
 The script must complete within the system-defined default timeout of 5
 minutes. For tasks that require more time, consider running them in the
 background using methods such as `&` or `nohup`.
      string startup_script = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getStartupScriptBytes in interface SlurmLoginNodesOrBuilder
      Returns:
      The bytes for startupScript.

    • getEnableOsLogin

      public boolean getEnableOsLogin()
       Optional. Whether [OS Login](https://cloud.google.com/compute/docs/oslogin)
 should be enabled on login node instances.
      bool enable_os_login = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEnableOsLogin in interface SlurmLoginNodesOrBuilder
      Returns:
      The enableOsLogin.

    • getEnablePublicIps

      public boolean getEnablePublicIps()
       Optional. Whether login node instances should be assigned [external IP
 addresses](https://cloud.google.com/compute/docs/ip-addresses#externaladdresses).
      bool enable_public_ips = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEnablePublicIps in interface SlurmLoginNodesOrBuilder
      Returns:
      The enablePublicIps.

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: SlurmLoginNodesOrBuilder
       Optional.
 [Labels](https://cloud.google.com/compute/docs/labeling-resources) that
 should be applied to each login node instance.
      map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsCount in interface SlurmLoginNodesOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       Optional.
 [Labels](https://cloud.google.com/compute/docs/labeling-resources) that
 should be applied to each login node instance.
      map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsLabels in interface SlurmLoginNodesOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface SlurmLoginNodesOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Optional.
 [Labels](https://cloud.google.com/compute/docs/labeling-resources) that
 should be applied to each login node instance.
      map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsMap in interface SlurmLoginNodesOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Optional.
 [Labels](https://cloud.google.com/compute/docs/labeling-resources) that
 should be applied to each login node instance.
      map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrDefault in interface SlurmLoginNodesOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Optional.
 [Labels](https://cloud.google.com/compute/docs/labeling-resources) that
 should be applied to each login node instance.
      map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrThrow in interface SlurmLoginNodesOrBuilder

    • getStorageConfigsList

      public List<StorageConfig> getStorageConfigsList()
       Optional. How [storage
 resources][google.cloud.hypercomputecluster.v1.StorageResource] should be
 mounted on each login node.
      repeated .google.cloud.hypercomputecluster.v1.StorageConfig storage_configs = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getStorageConfigsList in interface SlurmLoginNodesOrBuilder

    • getStorageConfigsOrBuilderList

      public List<? extends StorageConfigOrBuilder> getStorageConfigsOrBuilderList()
       Optional. How [storage
 resources][google.cloud.hypercomputecluster.v1.StorageResource] should be
 mounted on each login node.
      repeated .google.cloud.hypercomputecluster.v1.StorageConfig storage_configs = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getStorageConfigsOrBuilderList in interface SlurmLoginNodesOrBuilder

    • getStorageConfigsCount

      public int getStorageConfigsCount()
       Optional. How [storage
 resources][google.cloud.hypercomputecluster.v1.StorageResource] should be
 mounted on each login node.
      repeated .google.cloud.hypercomputecluster.v1.StorageConfig storage_configs = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getStorageConfigsCount in interface SlurmLoginNodesOrBuilder

    • getStorageConfigs

      public StorageConfig getStorageConfigs(int index)
       Optional. How [storage
 resources][google.cloud.hypercomputecluster.v1.StorageResource] should be
 mounted on each login node.
      repeated .google.cloud.hypercomputecluster.v1.StorageConfig storage_configs = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getStorageConfigs in interface SlurmLoginNodesOrBuilder

    • getStorageConfigsOrBuilder

      public StorageConfigOrBuilder getStorageConfigsOrBuilder(int index)
       Optional. How [storage
 resources][google.cloud.hypercomputecluster.v1.StorageResource] should be
 mounted on each login node.
      repeated .google.cloud.hypercomputecluster.v1.StorageConfig storage_configs = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getStorageConfigsOrBuilder in interface SlurmLoginNodesOrBuilder

    • getInstancesList

      public List<ComputeInstance> getInstancesList()
       Output only. Information about the login node instances that were created
 in Compute Engine.
      repeated .google.cloud.hypercomputecluster.v1.ComputeInstance instances = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getInstancesList in interface SlurmLoginNodesOrBuilder

    • getInstancesOrBuilderList

      public List<? extends ComputeInstanceOrBuilder> getInstancesOrBuilderList()
       Output only. Information about the login node instances that were created
 in Compute Engine.
      repeated .google.cloud.hypercomputecluster.v1.ComputeInstance instances = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getInstancesOrBuilderList in interface SlurmLoginNodesOrBuilder

    • getInstancesCount

      public int getInstancesCount()
       Output only. Information about the login node instances that were created
 in Compute Engine.
      repeated .google.cloud.hypercomputecluster.v1.ComputeInstance instances = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getInstancesCount in interface SlurmLoginNodesOrBuilder

    • getInstances

      public ComputeInstance getInstances(int index)
       Output only. Information about the login node instances that were created
 in Compute Engine.
      repeated .google.cloud.hypercomputecluster.v1.ComputeInstance instances = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getInstances in interface SlurmLoginNodesOrBuilder

    • getInstancesOrBuilder

      public ComputeInstanceOrBuilder getInstancesOrBuilder(int index)
       Output only. Information about the login node instances that were created
 in Compute Engine.
      repeated .google.cloud.hypercomputecluster.v1.ComputeInstance instances = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getInstancesOrBuilder in interface SlurmLoginNodesOrBuilder

    • hasBootDisk

      public boolean hasBootDisk()
       Optional. Boot disk for the login node.
      .google.cloud.hypercomputecluster.v1.BootDisk boot_disk = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasBootDisk in interface SlurmLoginNodesOrBuilder
      Returns:
      Whether the bootDisk field is set.

    • getBootDisk

      public BootDisk getBootDisk()
       Optional. Boot disk for the login node.
      .google.cloud.hypercomputecluster.v1.BootDisk boot_disk = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBootDisk in interface SlurmLoginNodesOrBuilder
      Returns:
      The bootDisk.

    • getBootDiskOrBuilder

      public BootDiskOrBuilder getBootDiskOrBuilder()
       Optional. Boot disk for the login node.
      .google.cloud.hypercomputecluster.v1.BootDisk boot_disk = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBootDiskOrBuilder in interface SlurmLoginNodesOrBuilder

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 SlurmLoginNodes parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static SlurmLoginNodes parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SlurmLoginNodes parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SlurmLoginNodes parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SlurmLoginNodes parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SlurmLoginNodes parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SlurmLoginNodes.Builder newBuilder()

    • newBuilder

      public static SlurmLoginNodes.Builder newBuilder(SlurmLoginNodes prototype)

    • toBuilder

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

    • newBuilderForType

      protected SlurmLoginNodes.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SlurmLoginNodes getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<SlurmLoginNodes> 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.GeneratedMessage

    • getDefaultInstanceForType

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