Google Cloud Hypercompute Cluster V1 Client - Class SlurmOrchestrator (0.3.0)

Reference documentation and code samples for the Google Cloud Hypercompute Cluster V1 Client class SlurmOrchestrator.

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

Generated from protobuf message google.cloud.hypercomputecluster.v1.SlurmOrchestrator

Namespace

Google \ Cloud \ HypercomputeCluster \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ login_nodes`	`SlurmLoginNodes` Required. Configuration for login nodes, which allow users to access the cluster over SSH.
`↳ node_sets`	`array<SlurmNodeSet>` Optional. Compute resource configuration for the Slurm nodesets in your cluster. If not specified, the cluster won't create any nodes.
`↳ partitions`	`array<SlurmPartition>` Optional. Configuration for the Slurm partitions in your cluster. Each partition can contain one or more nodesets, and you can submit separate jobs on each partition. If you don't specify at least one partition in your cluster, you can't submit jobs to the cluster.
`↳ default_partition`	`string` 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.
`↳ prolog_bash_scripts`	`string[]` Optional. Slurm prolog scripts, which will be executed by compute nodes before a node begins running a new job. Values must not be empty.
`↳ epilog_bash_scripts`	`string[]` Optional. Slurm epilog scripts, which will be executed by compute nodes whenever a node finishes running a job. Values must not be empty.

getLoginNodes

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

Returns
Type	Description
`SlurmLoginNodes\|null`

hasLoginNodes

clearLoginNodes

setLoginNodes

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

Parameter
Name	Description
`var`	`SlurmLoginNodes`

Returns
Type	Description
`$this`

getNodeSets

Optional. Compute resource configuration for the Slurm nodesets in your cluster. If not specified, the cluster won't create any nodes.

Returns
Type	Description
`Google\Protobuf\RepeatedField<SlurmNodeSet>`

setNodeSets

Optional. Compute resource configuration for the Slurm nodesets in your cluster. If not specified, the cluster won't create any nodes.

Parameter
Name	Description
`var`	`array<SlurmNodeSet>`

Returns
Type	Description
`$this`

getPartitions

Optional. Configuration for the Slurm partitions in your cluster. Each partition can contain one or more nodesets, and you can submit separate jobs on each partition. If you don't specify at least one partition in your cluster, you can't submit jobs to the cluster.

Returns
Type	Description
`Google\Protobuf\RepeatedField<SlurmPartition>`

setPartitions

Parameter
Name	Description
`var`	`array<SlurmPartition>`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`string`

setDefaultPartition

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPrologBashScripts

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

Returns
Type	Description
`Google\Protobuf\RepeatedField<string>`

setPrologBashScripts