Class SlurmLoginNodes (0.1.0)

public final class SlurmLoginNodes extends GeneratedMessageV3 implements SlurmLoginNodesOrBuilder

Configuration for Slurm login nodes in the cluster. Login nodes are Compute Engine VM instances that allow users to access the cluster over SSH.

Protobuf type google.cloud.hypercomputecluster.v1beta.SlurmLoginNodes

Static Fields

BOOT_DISK_FIELD_NUMBER

public static final int BOOT_DISK_FIELD_NUMBER
Field Value
Type Description
int

COUNT_FIELD_NUMBER

public static final int COUNT_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_OS_LOGIN_FIELD_NUMBER

public static final int ENABLE_OS_LOGIN_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_PUBLIC_IPS_FIELD_NUMBER

public static final int ENABLE_PUBLIC_IPS_FIELD_NUMBER
Field Value
Type Description
int

INSTANCES_FIELD_NUMBER

public static final int INSTANCES_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

MACHINE_TYPE_FIELD_NUMBER

public static final int MACHINE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

STARTUP_SCRIPT_FIELD_NUMBER

public static final int STARTUP_SCRIPT_FIELD_NUMBER
Field Value
Type Description
int

STORAGE_CONFIGS_FIELD_NUMBER

public static final int STORAGE_CONFIGS_FIELD_NUMBER
Field Value
Type Description
int

ZONE_FIELD_NUMBER

public static final int ZONE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SlurmLoginNodes getDefaultInstance()
Returns
Type Description
SlurmLoginNodes

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SlurmLoginNodes.Builder newBuilder()
Returns
Type Description
SlurmLoginNodes.Builder

newBuilder(SlurmLoginNodes prototype)

public static SlurmLoginNodes.Builder newBuilder(SlurmLoginNodes prototype)
Parameter
Name Description
prototype SlurmLoginNodes
Returns
Type Description
SlurmLoginNodes.Builder

parseDelimitedFrom(InputStream input)

public static SlurmLoginNodes parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SlurmLoginNodes
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SlurmLoginNodes parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SlurmLoginNodes
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SlurmLoginNodes parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SlurmLoginNodes
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SlurmLoginNodes parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SlurmLoginNodes
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SlurmLoginNodes parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SlurmLoginNodes
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SlurmLoginNodes parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SlurmLoginNodes
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SlurmLoginNodes parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SlurmLoginNodes
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SlurmLoginNodes parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SlurmLoginNodes
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SlurmLoginNodes parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SlurmLoginNodes
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SlurmLoginNodes parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SlurmLoginNodes
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SlurmLoginNodes parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SlurmLoginNodes
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SlurmLoginNodes parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SlurmLoginNodes
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SlurmLoginNodes> parser()
Returns
Type Description
Parser<SlurmLoginNodes>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels that should be applied to each login node instance.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBootDisk()

public BootDisk getBootDisk()

Optional. Boot disk for the login node.

.google.cloud.hypercomputecluster.v1beta.BootDisk boot_disk = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BootDisk

The bootDisk.

getBootDiskOrBuilder()

public BootDiskOrBuilder getBootDiskOrBuilder()

Optional. Boot disk for the login node.

.google.cloud.hypercomputecluster.v1beta.BootDisk boot_disk = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BootDiskOrBuilder

getCount()

public long getCount()

Required. Number of login node instances to create.

int64 count = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
long

The count.

getDefaultInstanceForType()

public SlurmLoginNodes getDefaultInstanceForType()
Returns
Type Description
SlurmLoginNodes

getEnableOsLogin()

public boolean getEnableOsLogin()

Optional. Whether OS Login should be enabled on login node instances.

bool enable_os_login = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enableOsLogin.

getEnablePublicIps()

public boolean getEnablePublicIps()

Optional. Whether login node instances should be assigned external IP addresses.

bool enable_public_ips = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enablePublicIps.

getInstances(int index)

public ComputeInstance getInstances(int index)

Output only. Information about the login node instances that were created in Compute Engine.

repeated .google.cloud.hypercomputecluster.v1beta.ComputeInstance instances = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ComputeInstance

getInstancesCount()

public int getInstancesCount()

Output only. Information about the login node instances that were created in Compute Engine.

repeated .google.cloud.hypercomputecluster.v1beta.ComputeInstance instances = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getInstancesList()

public List<ComputeInstance> getInstancesList()

Output only. Information about the login node instances that were created in Compute Engine.

repeated .google.cloud.hypercomputecluster.v1beta.ComputeInstance instances = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<ComputeInstance>

getInstancesOrBuilder(int index)

public ComputeInstanceOrBuilder getInstancesOrBuilder(int index)

Output only. Information about the login node instances that were created in Compute Engine.

repeated .google.cloud.hypercomputecluster.v1beta.ComputeInstance instances = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ComputeInstanceOrBuilder

getInstancesOrBuilderList()

public List<? extends ComputeInstanceOrBuilder> getInstancesOrBuilderList()

Output only. Information about the login node instances that were created in Compute Engine.

repeated .google.cloud.hypercomputecluster.v1beta.ComputeInstance instances = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.hypercomputecluster.v1beta.ComputeInstanceOrBuilder>

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels that should be applied to each login node instance.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels that should be applied to each login node instance.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels that should be applied to each login node instance.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Labels that should be applied to each login node instance.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getMachineType()

public String getMachineType()

Required. Name of the Compute Engine machine type to use for login nodes, e.g. n2-standard-2.

string machine_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The machineType.

getMachineTypeBytes()

public ByteString getMachineTypeBytes()

Required. Name of the Compute Engine machine type to use for login nodes, e.g. n2-standard-2.

string machine_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for machineType.

getParserForType()

public Parser<SlurmLoginNodes> getParserForType()
Returns
Type Description
Parser<SlurmLoginNodes>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartupScript()

public String getStartupScript()

Optional. Startup script to be run on each login node instance. Max 256KB.

string startup_script = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The startupScript.

getStartupScriptBytes()

public ByteString getStartupScriptBytes()

Optional. Startup script to be run on each login node instance. Max 256KB.

string startup_script = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for startupScript.

getStorageConfigs(int index)

public StorageConfig getStorageConfigs(int index)

Optional. How storage resources should be mounted on each login node.

repeated .google.cloud.hypercomputecluster.v1beta.StorageConfig storage_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
StorageConfig

getStorageConfigsCount()

public int getStorageConfigsCount()

Optional. How storage resources should be mounted on each login node.

repeated .google.cloud.hypercomputecluster.v1beta.StorageConfig storage_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getStorageConfigsList()

public List<StorageConfig> getStorageConfigsList()

Optional. How storage resources should be mounted on each login node.

repeated .google.cloud.hypercomputecluster.v1beta.StorageConfig storage_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<StorageConfig>

getStorageConfigsOrBuilder(int index)

public StorageConfigOrBuilder getStorageConfigsOrBuilder(int index)

Optional. How storage resources should be mounted on each login node.

repeated .google.cloud.hypercomputecluster.v1beta.StorageConfig storage_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
StorageConfigOrBuilder

getStorageConfigsOrBuilderList()

public List<? extends StorageConfigOrBuilder> getStorageConfigsOrBuilderList()

Optional. How storage resources should be mounted on each login node.

repeated .google.cloud.hypercomputecluster.v1beta.StorageConfig storage_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.hypercomputecluster.v1beta.StorageConfigOrBuilder>

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];

Returns
Type Description
String

The zone.

getZoneBytes()

public 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];

Returns
Type Description
ByteString

The bytes for zone.

hasBootDisk()

public boolean hasBootDisk()

Optional. Boot disk for the login node.

.google.cloud.hypercomputecluster.v1beta.BootDisk boot_disk = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the bootDisk field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SlurmLoginNodes.Builder newBuilderForType()
Returns
Type Description
SlurmLoginNodes.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SlurmLoginNodes.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SlurmLoginNodes.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SlurmLoginNodes.Builder toBuilder()
Returns
Type Description
SlurmLoginNodes.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException