Class SlurmOrchestrator (0.1.0)

public final class SlurmOrchestrator extends GeneratedMessageV3 implements SlurmOrchestratorOrBuilder

When set in Orchestrator, indicates that the cluster should use Slurm as the orchestrator.

Protobuf type google.cloud.hypercomputecluster.v1beta.SlurmOrchestrator

Static Fields

DEFAULT_PARTITION_FIELD_NUMBER

public static final int DEFAULT_PARTITION_FIELD_NUMBER
Field Value
Type Description
int

EPILOG_BASH_SCRIPTS_FIELD_NUMBER

public static final int EPILOG_BASH_SCRIPTS_FIELD_NUMBER
Field Value
Type Description
int

LOGIN_NODES_FIELD_NUMBER

public static final int LOGIN_NODES_FIELD_NUMBER
Field Value
Type Description
int

NODE_SETS_FIELD_NUMBER

public static final int NODE_SETS_FIELD_NUMBER
Field Value
Type Description
int

PARTITIONS_FIELD_NUMBER

public static final int PARTITIONS_FIELD_NUMBER
Field Value
Type Description
int

PROLOG_BASH_SCRIPTS_FIELD_NUMBER

public static final int PROLOG_BASH_SCRIPTS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SlurmOrchestrator getDefaultInstance()
Returns
Type Description
SlurmOrchestrator

getDescriptor()

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

newBuilder()

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

newBuilder(SlurmOrchestrator prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SlurmOrchestrator getDefaultInstanceForType()
Returns
Type Description
SlurmOrchestrator

getDefaultPartition()

public String getDefaultPartition()

Optional. Default partition to use for submitted jobs that do not explicitly specify a partition. Required if and only if there is more than one partition, in which case it must match the id of one of the partitions.

string default_partition = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The defaultPartition.

getDefaultPartitionBytes()

public ByteString getDefaultPartitionBytes()

Optional. Default partition to use for submitted jobs that do not explicitly specify a partition. Required if and only if there is more than one partition, in which case it must match the id of one of the partitions.

string default_partition = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for defaultPartition.

getEpilogBashScripts(int index)

public String getEpilogBashScripts(int index)

Optional. Slurm epilog scripts, which will be executed by compute nodes whenever a node finishes running a job. Values must not be empty.

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

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The epilogBashScripts at the given index.

getEpilogBashScriptsBytes(int index)

public ByteString getEpilogBashScriptsBytes(int index)

Optional. Slurm epilog scripts, which will be executed by compute nodes whenever a node finishes running a job. Values must not be empty.

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

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the epilogBashScripts at the given index.

getEpilogBashScriptsCount()

public int getEpilogBashScriptsCount()

Optional. Slurm epilog scripts, which will be executed by compute nodes whenever a node finishes running a job. Values must not be empty.

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

Returns
Type Description
int

The count of epilogBashScripts.

getEpilogBashScriptsList()

public ProtocolStringList getEpilogBashScriptsList()

Optional. Slurm epilog scripts, which will be executed by compute nodes whenever a node finishes running a job. Values must not be empty.

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

Returns
Type Description
ProtocolStringList

A list containing the epilogBashScripts.

getLoginNodes()

public SlurmLoginNodes getLoginNodes()

Required. Configuration for login nodes, which allow users to access the cluster over SSH.

.google.cloud.hypercomputecluster.v1beta.SlurmLoginNodes login_nodes = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SlurmLoginNodes

The loginNodes.

getLoginNodesOrBuilder()

public SlurmLoginNodesOrBuilder getLoginNodesOrBuilder()

Required. Configuration for login nodes, which allow users to access the cluster over SSH.

.google.cloud.hypercomputecluster.v1beta.SlurmLoginNodes login_nodes = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SlurmLoginNodesOrBuilder

getNodeSets(int index)

public SlurmNodeSet getNodeSets(int index)

Required. Configuration of Slurm nodesets, which define groups of compute resources that can be used by Slurm. At least one compute node is required.

repeated .google.cloud.hypercomputecluster.v1beta.SlurmNodeSet node_sets = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
SlurmNodeSet

getNodeSetsCount()

public int getNodeSetsCount()

Required. Configuration of Slurm nodesets, which define groups of compute resources that can be used by Slurm. At least one compute node is required.

repeated .google.cloud.hypercomputecluster.v1beta.SlurmNodeSet node_sets = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getNodeSetsList()

public List<SlurmNodeSet> getNodeSetsList()

Required. Configuration of Slurm nodesets, which define groups of compute resources that can be used by Slurm. At least one compute node is required.

repeated .google.cloud.hypercomputecluster.v1beta.SlurmNodeSet node_sets = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<SlurmNodeSet>

getNodeSetsOrBuilder(int index)

public SlurmNodeSetOrBuilder getNodeSetsOrBuilder(int index)

Required. Configuration of Slurm nodesets, which define groups of compute resources that can be used by Slurm. At least one compute node is required.

repeated .google.cloud.hypercomputecluster.v1beta.SlurmNodeSet node_sets = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
SlurmNodeSetOrBuilder

getNodeSetsOrBuilderList()

public List<? extends SlurmNodeSetOrBuilder> getNodeSetsOrBuilderList()

Required. Configuration of Slurm nodesets, which define groups of compute resources that can be used by Slurm. At least one compute node is required.

repeated .google.cloud.hypercomputecluster.v1beta.SlurmNodeSet node_sets = 1 [(.google.api.field_behavior) = REQUIRED];

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

getParserForType()

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

getPartitions(int index)

public SlurmPartition getPartitions(int index)

Required. Configuration of Slurm partitions, which group one or more nodesets. Acts as a queue against which jobs can be submitted. At least one partition is required.

repeated .google.cloud.hypercomputecluster.v1beta.SlurmPartition partitions = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
SlurmPartition

getPartitionsCount()

public int getPartitionsCount()

Required. Configuration of Slurm partitions, which group one or more nodesets. Acts as a queue against which jobs can be submitted. At least one partition is required.

repeated .google.cloud.hypercomputecluster.v1beta.SlurmPartition partitions = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getPartitionsList()

public List<SlurmPartition> getPartitionsList()

Required. Configuration of Slurm partitions, which group one or more nodesets. Acts as a queue against which jobs can be submitted. At least one partition is required.

repeated .google.cloud.hypercomputecluster.v1beta.SlurmPartition partitions = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<SlurmPartition>

getPartitionsOrBuilder(int index)

public SlurmPartitionOrBuilder getPartitionsOrBuilder(int index)

Required. Configuration of Slurm partitions, which group one or more nodesets. Acts as a queue against which jobs can be submitted. At least one partition is required.

repeated .google.cloud.hypercomputecluster.v1beta.SlurmPartition partitions = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
SlurmPartitionOrBuilder

getPartitionsOrBuilderList()

public List<? extends SlurmPartitionOrBuilder> getPartitionsOrBuilderList()

Required. Configuration of Slurm partitions, which group one or more nodesets. Acts as a queue against which jobs can be submitted. At least one partition is required.

repeated .google.cloud.hypercomputecluster.v1beta.SlurmPartition partitions = 2 [(.google.api.field_behavior) = REQUIRED];

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

getPrologBashScripts(int index)

public String getPrologBashScripts(int index)

Optional. Slurm prolog scripts, which will be executed by compute nodes before a node begins running a new job. Values must not be empty.

repeated string prolog_bash_scripts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The prologBashScripts at the given index.

getPrologBashScriptsBytes(int index)

public ByteString getPrologBashScriptsBytes(int index)

Optional. Slurm prolog scripts, which will be executed by compute nodes before a node begins running a new job. Values must not be empty.

repeated string prolog_bash_scripts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the prologBashScripts at the given index.

getPrologBashScriptsCount()

public int getPrologBashScriptsCount()

Optional. Slurm prolog scripts, which will be executed by compute nodes before a node begins running a new job. Values must not be empty.

repeated string prolog_bash_scripts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of prologBashScripts.

getPrologBashScriptsList()

public ProtocolStringList getPrologBashScriptsList()

Optional. Slurm prolog scripts, which will be executed by compute nodes before a node begins running a new job. Values must not be empty.

repeated string prolog_bash_scripts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the prologBashScripts.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasLoginNodes()

public boolean hasLoginNodes()

Required. Configuration for login nodes, which allow users to access the cluster over SSH.

.google.cloud.hypercomputecluster.v1beta.SlurmLoginNodes login_nodes = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the loginNodes field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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