Interface SlurmLoginNodesOrBuilder (0.8.0)

public interface SlurmLoginNodesOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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

getBootDisk()

public abstract BootDisk getBootDisk()

Optional. Boot disk for the login node.

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

Returns
Type Description
BootDisk

The bootDisk.

getBootDiskOrBuilder()

public abstract BootDiskOrBuilder getBootDiskOrBuilder()

Optional. Boot disk for the login node.

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

Returns
Type Description
BootDiskOrBuilder

getCount()

public abstract long getCount()

Required. Number of login node instances to create.

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

Returns
Type Description
long

The count.

getEnableOsLogin()

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

Parameter
Name Description
index int
Returns
Type Description
ComputeInstance

getInstancesCount()

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

Returns
Type Description
int

getInstancesList()

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

Returns
Type Description
List<ComputeInstance>

getInstancesOrBuilder(int index)

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

Parameter
Name Description
index int
Returns
Type Description
ComputeInstanceOrBuilder

getInstancesOrBuilderList()

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

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

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getStartupScript()

public abstract String getStartupScript()

Optional. Startup script 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];

Returns
Type Description
String

The startupScript.

getStartupScriptBytes()

public abstract ByteString getStartupScriptBytes()

Optional. Startup script 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];

Returns
Type Description
ByteString

The bytes for startupScript.

getStorageConfigs(int index)

public abstract StorageConfig getStorageConfigs(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
StorageConfig

getStorageConfigsCount()

public abstract int getStorageConfigsCount()

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

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

Returns
Type Description
int

getStorageConfigsList()

public abstract List<StorageConfig> getStorageConfigsList()

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

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

Returns
Type Description
List<StorageConfig>

getStorageConfigsOrBuilder(int index)

public abstract StorageConfigOrBuilder getStorageConfigsOrBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
StorageConfigOrBuilder

getStorageConfigsOrBuilderList()

public abstract List<? extends StorageConfigOrBuilder> getStorageConfigsOrBuilderList()

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

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

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

getZone()

public abstract 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 abstract 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 abstract boolean hasBootDisk()

Optional. Boot disk for the login node.

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

Returns
Type Description
boolean

Whether the bootDisk field is set.