Package Classes (0.1.0)

Summary of entries of Classes for google-cloud-hypercomputecluster.

Classes

HypercomputeClusterAsyncClient

Service describing handlers for resources

HypercomputeClusterClient

Service describing handlers for resources

ListClustersAsyncPager

A pager for iterating through list_clusters requests.

This class thinly wraps an initial ListClustersResponse object, and provides an __aiter__ method to iterate through its clusters field.

If there are more pages, the __aiter__ method will make additional ListClusters requests and continue to iterate through the clusters field on the corresponding responses.

All the usual ListClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListClustersPager

A pager for iterating through list_clusters requests.

This class thinly wraps an initial ListClustersResponse object, and provides an __iter__ method to iterate through its clusters field.

If there are more pages, the __iter__ method will make additional ListClusters requests and continue to iterate through the clusters field on the corresponding responses.

All the usual ListClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

BootDisk

A Persistent disk <https://cloud.google.com/compute/docs/disks>__ used as the boot disk for a Compute Engine VM instance.

BucketReference

A reference to a Google Cloud Storage <https://cloud.google.com/storage>__ bucket.

Cluster

A collection of virtual machines and connected resources forming a high-performance computing cluster capable of running large-scale, tightly coupled workloads. A cluster combines a set a compute resources that perform computations, storage resources that contain inputs and store outputs, an orchestrator that is responsible for assigning jobs to compute resources, and network resources that connect everything together.

ComputeResourcesEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

NetworkResourcesEntry

The abstract base class for a message.

StorageResourcesEntry

The abstract base class for a message.

ComputeInstance

Details about a Compute Engine instance <https://cloud.google.com/compute/docs/instances>__.

ComputeInstanceSlurmNodeSet

When set in a SlurmNodeSet, indicates that the nodeset should be backed by Compute Engine VM instances.

LabelsEntry

The abstract base class for a message.

ComputeResource

A resource defining how virtual machines and accelerators should be provisioned for the cluster.

ComputeResourceConfig

Describes how a compute resource should be created at runtime.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CreateClusterRequest

Request message for CreateCluster.

DeleteClusterRequest

Request message for DeleteCluster.

ExistingBucketConfig

When set in a StorageResourceConfig, indicates that an existing Google Cloud Storage <https://cloud.google.com/storage>__ bucket should be imported.

ExistingFilestoreConfig

When set in a StorageResourceConfig, indicates that an existing Filestore <https://cloud.google.com/filestore>__ instance should be imported.

ExistingLustreConfig

When set in a StorageResourceConfig, indicates that an existing Managed Lustre <https://cloud.google.com/products/managed-lustre>__ instance should be imported.

ExistingNetworkConfig

When set in a NetworkResourceConfig, indicates that an existing network should be imported.

FileShareConfig

Message describing filestore configuration

FilestoreReference

A reference to a Filestore <https://cloud.google.com/filestore>__ instance.

GcsAutoclassConfig

Message describing Google Cloud Storage autoclass configuration

TerminalStorageClass

Terminal storage class types of the autoclass bucket

GcsHierarchicalNamespaceConfig

Message describing Google Cloud Storage hierarchical namespace configuration

GetClusterRequest

Request message for GetCluster.

ListClustersRequest

Request message for ListClusters.

ListClustersResponse

Response message for ListClusters.

LustreReference

A reference to a Managed Lustre <https://cloud.google.com/products/managed-lustre>__ instance.

NetworkReference

A reference to a VPC network <https://cloud.google.com/vpc/docs/vpc>__ in Google Compute Engine.

NetworkResource

A resource representing a network that connects the various components of a cluster together.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

NetworkResourceConfig

Describes how a network resource should be initialized. Each network resource can either be imported from an existing Google Cloud resource or initialized when the cluster is created.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

NewBucketConfig

When set in a StorageResourceConfig, indicates that a new Google Cloud Storage <https://cloud.google.com/storage>__ bucket should be created.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

StorageClass

Storage class <https://cloud.google.com/storage/docs/storage-classes>__ for a Cloud Storage bucket.

NewFilestoreConfig

When set in a StorageResourceConfig, indicates that a new Filestore <https://cloud.google.com/filestore>__ instance should be created.

Protocol

File access protocol for Filestore instances.

Tier

Available service tiers <https://cloud.google.com/filestore/docs/service-tiers>__ for Filestore instances.

NewFlexStartInstancesConfig

When set in a ComputeResourceConfig, indicates that VM instances should be created using Flex Start <https://cloud.google.com/compute/docs/instances/provisioning-models>__.

NewLustreConfig

When set in a StorageResourceConfig, indicates that a new Managed Lustre <https://cloud.google.com/products/managed-lustre>__ instance should be created.

NewNetworkConfig

When set in a NetworkResourceConfig, indicates that a new network should be created.

NewOnDemandInstancesConfig

When set in a ComputeResourceConfig, indicates that on-demand (i.e., using the standard provisioning model) VM instances should be created.

NewReservedInstancesConfig

When set in a ComputeResourceConfig, indicates that VM instances should be created from a reservation <https://cloud.google.com/compute/docs/instances/reservations-overview>__.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

NewSpotInstancesConfig

When set in a ComputeResourceConfig, indicates that spot VM <https://cloud.google.com/compute/docs/instances/spot>__ instances should be created.

OperationMetadata

Represents the metadata of the long-running operation.

Orchestrator

The component responsible for scheduling and running workloads on the cluster as well as providing the user interface for interacting with the cluster at runtime.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SlurmLoginNodes

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.

LabelsEntry

The abstract base class for a message.

SlurmNodeSet

Configuration for Slurm nodesets in the cluster. Nodesets are groups of compute nodes used by Slurm that are responsible for running workloads submitted to the cluster.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SlurmOrchestrator

When set in Orchestrator, indicates that the cluster should use Slurm <https://slurm.schedmd.com/>__ as the orchestrator.

SlurmPartition

Configuration for Slurm partitions in the cluster. Partitions are groups of nodesets, and are how clients specify where their workloads should be run.

StorageConfig

Description of how a [storage resource][google.cloud.hypercomputecluster.v1beta.StorageResource] should be mounted on a VM instance.

StorageResource

A resource representing a form of persistent storage that is accessible to compute resources in the cluster.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

StorageResourceConfig

Describes how a storage resource should be initialized. Each storage resource can either be imported from an existing Google Cloud resource or initialized when the cluster is created.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

UpdateClusterRequest

Request message for UpdateCluster.

Modules

pagers

API documentation for hypercomputecluster_v1beta.services.hypercompute_cluster.pagers module.