{ "discoveryVersion": "v1", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "ownerName": "Google", "title": "Cluster Director API", "ownerDomain": "google.com", "description": "The Cluster Director API lets you deploy, manage, and monitor clusters that run artificial intelligence (AI), machine learning (ML), or high performance computing (HPC) workloads.", "version_module": true, "name": "hypercomputecluster", "parameters": { "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query", "type": "boolean" }, "alt": { "description": "Data format for response.", "location": "query", "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "enum": [ "json", "media", "proto" ], "type": "string" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, "$.xgafv": { "enumDescriptions": [ "v1 error format", "v2 error format" ], "enum": [ "1", "2" ], "location": "query", "type": "string", "description": "V1 error format." }, "fields": { "location": "query", "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "key": { "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query", "type": "string" }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "callback": { "location": "query", "type": "string", "description": "JSONP" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" } }, "fullyEncodeReservedExpansion": true, "canonicalName": "Hypercompute Cluster", "batchPath": "batch", "resources": { "projects": { "resources": { "locations": { "methods": { "list": { "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations", "httpMethod": "GET", "path": "v1beta/{+name}/locations", "parameters": { "name": { "type": "string", "required": true, "location": "path", "description": "The resource that owns the locations collection, if applicable.", "pattern": "^projects/[^/]+$" }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "type": "string", "location": "query" }, "extraLocationTypes": { "location": "query", "type": "string", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "repeated": true }, "filter": { "location": "query", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query" } }, "parameterOrder": [ "name" ], "id": "hypercomputecluster.projects.locations.list", "response": { "$ref": "ListLocationsResponse" } }, "get": { "path": "v1beta/{+name}", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}", "parameters": { "name": { "description": "Resource name for the location.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" } }, "id": "hypercomputecluster.projects.locations.get", "parameterOrder": [ "name" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Location" }, "description": "Gets information about a location." } }, "resources": { "clusters": { "methods": { "list": { "parameters": { "parent": { "type": "string", "description": "Required. Parent location of the clusters to list, in the format `projects/{project}/locations/{location}`.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageSize": { "description": "Optional. Maximum number of clusters to return. The service may return fewer than this value.", "location": "query", "format": "int32", "type": "integer" }, "filter": { "location": "query", "type": "string", "description": "Optional. [Filter](https://google.aip.dev/160) to apply to the returned results." }, "pageToken": { "description": "Optional. A page token received from a previous `ListClusters` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListClusters` must match the call that provided the page token.", "type": "string", "location": "query" }, "orderBy": { "type": "string", "location": "query", "description": "Optional. How to order the resulting clusters. Must be one of the following strings: * `name` * `name desc` * `create_time` * `create_time desc` If not specified, clusters will be returned in an arbitrary order." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "id": "hypercomputecluster.projects.locations.clusters.list", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/clusters", "description": "Lists Clusters in a given project and location.", "parameterOrder": [ "parent" ], "path": "v1beta/{+parent}/clusters", "response": { "$ref": "ListClustersResponse" } }, "create": { "description": "Creates a new Cluster in a given project and location.", "path": "v1beta/{+parent}/clusters", "httpMethod": "POST", "response": { "$ref": "Operation" }, "parameters": { "requestId": { "description": "Optional. A unique identifier for this request. A random UUID is recommended. This request is idempotent if and only if `request_id` is provided.", "type": "string", "location": "query" }, "parent": { "required": true, "type": "string", "description": "Required. Parent location in which the cluster should be created, in the format `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "clusterId": { "description": "Required. The ID of the cluster to create. The cluster ID must start with a lowercase letter (`a`-`z`), use only lowercase letters or numbers, and contain up to 10 characters. For example, specify `cluster001`.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "Cluster" }, "id": "hypercomputecluster.projects.locations.clusters.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/clusters" }, "delete": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", "path": "v1beta/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "id": "hypercomputecluster.projects.locations.clusters.delete", "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "parameters": { "requestId": { "location": "query", "type": "string", "description": "Optional. A unique identifier for this request. A random UUID is recommended. This request is idempotent if and only if `request_id` is provided." }, "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "description": "Required. Name of the cluster to delete, in the format `projects/{project}/locations/{location}/clusters/{cluster}`.", "location": "path" } }, "description": "Deletes a single Cluster." }, "get": { "path": "v1beta/{+name}", "response": { "$ref": "Cluster" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "location": "path", "type": "string", "description": "Required. Name of the cluster to retrieve, in the format `projects/{project}/locations/{location}/clusters/{cluster}`." } }, "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", "id": "hypercomputecluster.projects.locations.clusters.get", "description": "Gets details of a single Cluster." }, "patch": { "id": "hypercomputecluster.projects.locations.clusters.patch", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "Cluster" }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "path": "v1beta/{+name}", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "description": "Identifier. [Relative resource name](https://google.aip.dev/122) of the cluster, in the format `projects/{project}/locations/{location}/clusters/{cluster}`.", "type": "string", "location": "path" }, "requestId": { "type": "string", "description": "Optional. A unique identifier for this request. A random UUID is recommended. This request is idempotent if and only if `request_id` is provided.", "location": "query" }, "updateMask": { "location": "query", "format": "google-fieldmask", "type": "string", "description": "Optional. Mask specifying which fields in the cluster to update. All paths must be specified explicitly - wildcards are not supported. At least one path must be provided." } }, "response": { "$ref": "Operation" }, "description": "Updates the parameters of a single Cluster." } }, "resources": { "nodes": { "methods": { "list": { "path": "v1beta/{+parent}/nodes", "response": { "$ref": "ListNodesResponse" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "description": "Required. Parent cluster of the nodes to list, in the format `projects/{project}/locations/{location}/clusters/{cluster}`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "type": "string", "required": true }, "filter": { "description": "Optional. [Filter](https://google.aip.dev/160) to apply to the returned results.", "type": "string", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "Optional. Maximum number of nodes to return. The service may return fewer than this value." }, "orderBy": { "type": "string", "description": "Optional. How to order the resulting nodes. Must be one of the following strings: * `name` * `name desc` If not specified, nodes will be returned in an arbitrary order.", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A page token received from a previous `ListNodes` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListNodes` must match the call that provided the page token." } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodes", "id": "hypercomputecluster.projects.locations.clusters.nodes.list", "httpMethod": "GET", "description": "Lists Nodes in a given cluster." } } } } }, "operations": { "methods": { "delete": { "id": "hypercomputecluster.projects.locations.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "required": true, "location": "path", "type": "string" } }, "path": "v1beta/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE" }, "cancel": { "path": "v1beta/{+name}:cancel", "response": { "$ref": "Empty" }, "request": { "$ref": "CancelOperationRequest" }, "id": "hypercomputecluster.projects.locations.operations.cancel", "parameters": { "name": { "location": "path", "description": "The name of the operation resource to be cancelled.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "httpMethod": "POST", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." }, "get": { "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "description": "The name of the operation resource.", "location": "path", "type": "string" } }, "httpMethod": "GET", "id": "hypercomputecluster.projects.locations.operations.get", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}" }, "list": { "response": { "$ref": "ListOperationsResponse" }, "parameters": { "pageSize": { "location": "query", "type": "integer", "description": "The standard list page size.", "format": "int32" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "The name of the operation's parent resource.", "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "path": "v1beta/{+name}/operations", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations", "id": "hypercomputecluster.projects.locations.operations.list", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." } } } } } } } }, "basePath": "", "version": "v1beta", "schemas": { "SlurmPartition": { "description": "Configuration for Slurm partitions in the cluster. Partitions are groups of nodesets, and are how clients specify where their workloads should be run.", "properties": { "id": { "type": "string", "description": "Required. ID of the partition, which is how users will identify it. Must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters)." }, "nodeSetIds": { "items": { "type": "string" }, "type": "array", "description": "Required. IDs of the nodesets that make up this partition. Values must match SlurmNodeSet.id." } }, "id": "SlurmPartition", "type": "object" }, "NewFilestoreConfig": { "description": "When set in a StorageResourceConfig, indicates that a new [Filestore](https://cloud.google.com/filestore) instance should be created.", "id": "NewFilestoreConfig", "type": "object", "properties": { "filestore": { "description": "Required. Immutable. Name of the Filestore instance to create, in the format `projects/{project}/locations/{location}/instances/{instance}`.", "type": "string" }, "fileShares": { "description": "Required. Immutable. File system shares on the instance. Exactly one file share must be specified.", "items": { "$ref": "FileShareConfig" }, "type": "array" }, "tier": { "type": "string", "description": "Required. Immutable. Service tier to use for the instance.", "enum": [ "TIER_UNSPECIFIED", "ZONAL", "REGIONAL" ], "enumDescriptions": [ "Not set.", "Offers expanded capacity and performance scaling capabilities suitable for high-performance computing application requirements.", "Offers features and availability needed for mission-critical, high-performance computing workloads." ] }, "description": { "type": "string", "description": "Optional. Immutable. Description of the instance. Maximum of 2048 characters." }, "protocol": { "enumDescriptions": [ "Not set.", "NFS 3.0.", "NFS 4.1." ], "type": "string", "description": "Optional. Immutable. Access protocol to use for all file shares in the instance. Defaults to NFS V3 if not set.", "enum": [ "PROTOCOL_UNSPECIFIED", "NFSV3", "NFSV41" ] } } }, "BootDisk": { "description": "A [Persistent disk](https://cloud.google.com/compute/docs/disks) used as the boot disk for a Compute Engine VM instance.", "id": "BootDisk", "type": "object", "properties": { "sizeGb": { "format": "int64", "description": "Optional. The size of the disk in gigabytes (GB), which must be at least 40 GB.", "type": "string" }, "type": { "description": "Optional. [Persistent disk type](https://cloud.google.com/compute/docs/disks#disk-types), in the format `projects/{project}/zones/{zone}/diskTypes/{disk_type}`.", "type": "string" } } }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", "type": "object", "properties": {} }, "NetworkReference": { "type": "object", "id": "NetworkReference", "properties": { "subnetwork": { "description": "Output only. Name of the particular subnetwork being used by the cluster, in the format `projects/{project}/regions/{region}/subnetworks/{subnetwork}`.", "readOnly": true, "type": "string" }, "network": { "readOnly": true, "description": "Output only. Name of the network, in the format `projects/{project}/global/networks/{network}`.", "type": "string" } }, "description": "A reference to a [VPC network](https://cloud.google.com/vpc/docs/vpc) in Google Compute Engine." }, "NewBucketConfig": { "type": "object", "id": "NewBucketConfig", "description": "When set in a StorageResourceConfig, indicates that a new [Google Cloud Storage](https://cloud.google.com/storage) bucket should be created.", "properties": { "bucket": { "description": "Required. Immutable. Name of the Cloud Storage bucket to create.", "type": "string" }, "autoclass": { "$ref": "GcsAutoclassConfig", "description": "Optional. Immutable. If set, indicates that the bucket should use [Autoclass](https://cloud.google.com/storage/docs/autoclass)." }, "hierarchicalNamespace": { "description": "Optional. Immutable. If set, indicates that the bucket should use [hierarchical namespaces](https://cloud.google.com/storage/docs/hns-overview).", "$ref": "GcsHierarchicalNamespaceConfig" }, "storageClass": { "description": "Optional. Immutable. If set, uses the provided storage class as the bucket's default storage class.", "enum": [ "STORAGE_CLASS_UNSPECIFIED", "STANDARD", "NEARLINE", "COLDLINE", "ARCHIVE", "RAPID" ], "enumDescriptions": [ "Not set.", "Best for data that is frequently accessed.", "Low-cost storage for data that is accessed less frequently.", "Very low-cost storage for infrequently accessed data.", "Lowest-cost storage for data archiving, online backup, and disaster recovery.", "Storage class optimized for I/O intensive workloads." ], "type": "string" } } }, "ComputeResource": { "properties": { "config": { "$ref": "ComputeResourceConfig", "description": "Required. Immutable. Configuration for this compute resource, which describes how it should be created at runtime." } }, "id": "ComputeResource", "type": "object", "description": "A resource defining how virtual machines and accelerators should be provisioned for the cluster." }, "ListLocationsResponse": { "id": "ListLocationsResponse", "description": "The response message for Locations.ListLocations.", "type": "object", "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "locations": { "type": "array", "description": "A list of locations that matches the specified filter in the request.", "items": { "$ref": "Location" } } } }, "ExistingBucketConfig": { "properties": { "bucket": { "type": "string", "description": "Required. Immutable. Name of the Cloud Storage bucket to import." } }, "id": "ExistingBucketConfig", "type": "object", "description": "When set in a StorageResourceConfig, indicates that an existing [Google Cloud Storage](https://cloud.google.com/storage) bucket should be imported." }, "ExistingNfsConfig": { "properties": { "mountOptions": { "type": "string", "description": "Optional. Immutable. Options to mount the NFS share, as expected by fs_mntops field infstab(5), for example: \"rw,vers=4.1,nconnect=2,noatime\"." }, "remoteMount": { "description": "Required. Immutable. Remote mount path of the NFS share.", "type": "string" }, "serverIpAddress": { "type": "string", "description": "Required. Immutable. Server IP address of the NFS share." } }, "description": "When set in a StorageResourceConfig, indicates that an existing NFS share should be imported.", "type": "object", "id": "ExistingNfsConfig" }, "LustreReference": { "properties": { "lustre": { "readOnly": true, "type": "string", "description": "Output only. Name of the Managed Lustre instance, in the format `projects/{project}/locations/{location}/instances/{instance}`" } }, "id": "LustreReference", "description": "A reference to a [Managed Lustre](https://cloud.google.com/products/managed-lustre) instance.", "type": "object" }, "Orchestrator": { "id": "Orchestrator", "type": "object", "properties": { "slurm": { "$ref": "SlurmOrchestrator", "description": "Optional. If set, indicates that the cluster should use Slurm as the orchestrator." } }, "description": "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." }, "OperationProgress": { "properties": { "steps": { "readOnly": true, "type": "array", "items": { "$ref": "OperationStep" }, "description": "Output only. Steps and status of the operation." } }, "type": "object", "description": "Message describing the progress of a cluster mutation long-running operation.", "id": "OperationProgress" }, "UpdatePartition": { "description": "When set in OperationStep, indicates that a partition should be updated.", "id": "UpdatePartition", "type": "object", "properties": { "partitions": { "type": "array", "readOnly": true, "items": { "type": "string" }, "description": "Output only. Name of the partition to update" } } }, "GcsAutoclassConfig": { "id": "GcsAutoclassConfig", "type": "object", "description": "Message describing Google Cloud Storage autoclass configuration", "properties": { "enabled": { "type": "boolean", "description": "Required. Enables Auto-class feature." }, "terminalStorageClass": { "enumDescriptions": [ "Unspecified terminal storage class", "Nearline terminal storage class", "Archive terminal storage class" ], "description": "Optional. Terminal storage class of the autoclass bucket", "type": "string", "enum": [ "TERMINAL_STORAGE_CLASS_UNSPECIFIED", "NEARLINE", "ARCHIVE" ] } } }, "UpdateNodeset": { "description": "When set in OperationStep, indicates that a nodeset should be updated.", "id": "UpdateNodeset", "type": "object", "properties": { "nodesets": { "type": "array", "readOnly": true, "description": "Output only. Name of the nodeset to update", "items": { "type": "string" } } } }, "UpdateLoginNode": { "id": "UpdateLoginNode", "properties": {}, "description": "When set in OperationStep, indicates that a login node should be updated.", "type": "object" }, "ListOperationsResponse": { "id": "ListOperationsResponse", "type": "object", "description": "The response message for Operations.ListOperations.", "properties": { "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Operation" } }, "unreachable": { "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } } }, "DeletePartition": { "type": "object", "properties": { "partitions": { "items": { "type": "string" }, "readOnly": true, "type": "array", "description": "Output only. Name of the partition to delete" } }, "description": "When set in OperationStep, indicates that a partition should be deleted.", "id": "DeletePartition" }, "DeleteLoginNode": { "id": "DeleteLoginNode", "properties": {}, "description": "When set in OperationStep, indicates that a login node should be deleted.", "type": "object" }, "NewNetworkConfig": { "properties": { "network": { "description": "Required. Immutable. Name of the network to create, in the format `projects/{project}/global/networks/{network}`.", "type": "string" }, "description": { "description": "Optional. Immutable. Description of the network. Maximum of 2048 characters.", "type": "string" } }, "type": "object", "id": "NewNetworkConfig", "description": "When set in a NetworkResourceConfig, indicates that a new network should be created." }, "ListNodesResponse": { "description": "Response message for ListNodes.", "type": "object", "id": "ListNodesResponse", "properties": { "nextPageToken": { "type": "string", "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is absent, there are no subsequent pages." }, "nodes": { "type": "array", "items": { "$ref": "Node" }, "description": "Nodes in the specified cluster." } } }, "Node": { "properties": { "provisioningModel": { "enum": [ "PROVISIONING_MODEL_UNSPECIFIED", "ON_DEMAND", "SPOT", "RESERVATION_BOUND", "FLEX_START" ], "type": "string", "readOnly": true, "description": "Output only. Provisioning model of the node.", "enumDescriptions": [ "Not set.", "The node is provisioned on demand. User controlled runtime, no discounts.", "The node is provisioned as a spot VM. Heavily discounted, no guaranteed runtime.", "The node is provisioned as a reservation-bound VM. Bound to the lifecycle of the reservation in which it is provisioned.", "The node is provisioned as a flex-start VM. Has a limited runtime." ] }, "acceptingJobs": { "readOnly": true, "type": "boolean", "description": "Output only. Indicates whether the node is available for new job allocations." }, "createTime": { "type": "string", "description": "Output only. Time that the node was originally created.", "format": "google-datetime", "readOnly": true }, "state": { "description": "Output only. High-level lifecycle state of the node.", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "SUSPENDING", "SUSPENDED", "REPAIRING", "FAILED", "DELETING", "UNPROVISIONED" ], "type": "string", "enumDescriptions": [ "Not set.", "The node is being provisioned at the infrastructure layer or initialized by the orchestrator.", "The node is healthy and operational.", "The node is transitioning to a stopped or suspended state.", "The node is suspended or stopped and not consuming compute resources.", "The node is undergoing maintenance or automatic recovery.", "The node is in an unhealthy or terminal error state.", "The node is being deleted.", "The node has no VM assigned to it." ] }, "updateTime": { "format": "google-datetime", "description": "Output only. Time that the node was most recently updated.", "readOnly": true, "type": "string" }, "zone": { "readOnly": true, "description": "Output only. Name of the zone in which the node is running, e.g. `us-central1-a`.", "type": "string" }, "computeEngineDetails": { "$ref": "ComputeEngineNodeDetails", "description": "Output only. Compute Engine-specific details for the node.", "readOnly": true }, "slurmDetails": { "$ref": "SlurmNodeDetails", "description": "Output only. Slurm-specific details for the node.", "readOnly": true }, "runningJobs": { "readOnly": true, "type": "boolean", "description": "Output only. Indicates whether the node is currently executing workloads." }, "stateMessage": { "type": "string", "description": "Output only. Human-readable message providing extra information about the current state.", "readOnly": true }, "name": { "description": "Identifier. [Relative resource name](https://google.aip.dev/122) of the node, in the format `projects/{project}/locations/{location}/clusters/{cluster}/nodes/{node}`.", "type": "string" } }, "type": "object", "description": "A resource representing a compute node managed by Cluster Director.", "id": "Node" }, "CreateNetwork": { "type": "object", "id": "CreateNetwork", "description": "When set in OperationStep, indicates that a new network should be created.", "properties": { "network": { "readOnly": true, "type": "string", "description": "Output only. Name of the network to create, in the format `projects/{project}/global/networks/{network}`." } } }, "SlurmLoginNodes": { "id": "SlurmLoginNodes", "description": "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.", "properties": { "enablePublicIps": { "type": "boolean", "description": "Optional. Whether login node instances should be assigned [external IP addresses](https://cloud.google.com/compute/docs/ip-addresses#externaladdresses)." }, "storageConfigs": { "items": { "$ref": "StorageConfig" }, "type": "array", "description": "Optional. How storage resources should be mounted on each login node." }, "networkTags": { "description": "Optional. Network tags to be applied to each login node instance. A maximum of 64 network tags are allowed.", "type": "array", "items": { "type": "string" } }, "enableOsLogin": { "type": "boolean", "description": "Optional. Whether [OS Login](https://cloud.google.com/compute/docs/oslogin) should be enabled on login node instances." }, "count": { "description": "Required. Number of login node instances to create.", "type": "string", "format": "int64" }, "instances": { "readOnly": true, "type": "array", "description": "Output only. Information about the login node instances that were created in Compute Engine.", "items": { "$ref": "ComputeInstance" } }, "bootDisk": { "description": "Optional. Boot disk for the login node.", "$ref": "BootDisk" }, "labels": { "description": "Optional. [Labels](https://cloud.google.com/compute/docs/labeling-resources) that should be applied to each login node instance.", "type": "object", "additionalProperties": { "type": "string" } }, "machineType": { "description": "Required. Name of the Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-resource) to use for login nodes, e.g. `n2-standard-2`.", "type": "string" }, "startupScript": { "type": "string", "description": "Optional. [Startup script](https://cloud.google.com/compute/docs/instances/startup-scripts/linux) 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`." }, "zone": { "description": "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.", "type": "string" } }, "type": "object" }, "CreateLustreInstance": { "id": "CreateLustreInstance", "description": "When set in OperationStep, indicates that a new lustre instance should be created.", "type": "object", "properties": { "lustre": { "description": "Output only. Name of the Managed Lustre instance, in the format `projects/{project}/locations/{location}/instances/{instance}`", "readOnly": true, "type": "string" } } }, "CreatePartition": { "properties": { "partitions": { "type": "array", "readOnly": true, "items": { "type": "string" }, "description": "Output only. Name of the partition to create" } }, "type": "object", "id": "CreatePartition", "description": "When set in OperationStep, indicates that a partition should be created." }, "CreateNodeset": { "properties": { "nodesets": { "items": { "type": "string" }, "type": "array", "readOnly": true, "description": "Output only. Name of the nodeset to create" } }, "description": "When set in OperationStep, indicates that a nodeset should be created.", "type": "object", "id": "CreateNodeset" }, "FilestoreReference": { "description": "A reference to a [Filestore](https://cloud.google.com/filestore) instance.", "properties": { "filestore": { "readOnly": true, "description": "Output only. Name of the Filestore instance, in the format `projects/{project}/locations/{location}/instances/{instance}`", "type": "string" } }, "type": "object", "id": "FilestoreReference" }, "OperationStep": { "properties": { "createOrchestrator": { "$ref": "CreateOrchestrator", "description": "Output only. If set, indicates that orchestrator creation is part of the operation.", "readOnly": true }, "deleteOrchestrator": { "description": "Output only. If set, indicates that orchestrator deletion is part of the operation.", "$ref": "DeleteOrchestrator", "readOnly": true }, "checkClusterHealth": { "readOnly": true, "description": "Output only. If set, indicates that cluster health check is part of the operation.", "$ref": "CheckClusterHealth" }, "deleteLustreInstance": { "readOnly": true, "$ref": "DeleteLustreInstance", "description": "Output only. If set, indicates that Lustre instance deletion is part of the operation." }, "createFilestoreInstance": { "$ref": "CreateFilestoreInstance", "readOnly": true, "description": "Output only. If set, indicates that new Filestore instance creation is part of the operation." }, "createPartition": { "description": "Output only. If set, indicates that new partition creation is part of the operation.", "$ref": "CreatePartition", "readOnly": true }, "updatePartition": { "description": "Output only. If set, indicates that partition update is part of the operation.", "readOnly": true, "$ref": "UpdatePartition" }, "deleteNodeset": { "$ref": "DeleteNodeset", "readOnly": true, "description": "Output only. If set, indicates that nodeset deletion is part of the operation." }, "updateOrchestrator": { "readOnly": true, "$ref": "UpdateOrchestrator", "description": "Output only. If set, indicates that an orchestrator update is part of the operation." }, "createLoginNode": { "readOnly": true, "$ref": "CreateLoginNode", "description": "Output only. If set, indicates that new login node creation is part of the operation." }, "deletePrivateServiceAccess": { "$ref": "DeletePrivateServiceAccess", "description": "Output only. If set, indicates that private service access deletion is part of the operation.", "readOnly": true }, "createNodeset": { "readOnly": true, "$ref": "CreateNodeset", "description": "Output only. If set, indicates that new nodeset creation is part of the operation." }, "createNetwork": { "readOnly": true, "$ref": "CreateNetwork", "description": "Output only. If set, indicates that new network creation is part of the operation." }, "createPrivateServiceAccess": { "readOnly": true, "$ref": "CreatePrivateServiceAccess", "description": "Output only. If set, indicates that new private service access creation is part of the operation." }, "deletePartition": { "description": "Output only. If set, indicates that partition deletion is part of the operation.", "$ref": "DeletePartition", "readOnly": true }, "state": { "description": "Output only. State of the operation step.", "readOnly": true, "type": "string", "enum": [ "STATE_UNSPECIFIED", "WAITING", "IN_PROGRESS", "DONE" ], "enumDescriptions": [ "Unspecified state.", "Initial state before step execution starts.", "Step execution is running in progress.", "Step execution is completed." ] }, "updateLoginNode": { "$ref": "UpdateLoginNode", "description": "Output only. If set, indicates that login node update is part of the operation.", "readOnly": true }, "deleteLoginNode": { "readOnly": true, "description": "Output only. If set, indicates that login node deletion is part of the operation.", "$ref": "DeleteLoginNode" }, "createLustreInstance": { "$ref": "CreateLustreInstance", "readOnly": true, "description": "Output only. If set, indicates that new Lustre instance creation is part of the operation." }, "deleteFilestoreInstance": { "$ref": "DeleteFilestoreInstance", "description": "Output only. If set, indicates that Filestore instance deletion is part of the operation.", "readOnly": true }, "deleteStorageBucket": { "$ref": "DeleteStorageBucket", "readOnly": true, "description": "Output only. If set, indicates that Cloud Storage bucket deletion is part of the operation." }, "updateNodeset": { "readOnly": true, "$ref": "UpdateNodeset", "description": "Output only. If set, indicates that nodeset update is part of the operation." }, "createStorageBucket": { "$ref": "CreateStorageBucket", "readOnly": true, "description": "Output only. If set, indicates that new Cloud Storage bucket creation is part of the operation." }, "deleteNetwork": { "$ref": "DeleteNetwork", "readOnly": true, "description": "Output only. If set, indicates that network deletion is part of the operation." } }, "description": "Message describing the status of a single step in a cluster mutation long-running operation.", "type": "object", "id": "OperationStep" }, "ListClustersResponse": { "type": "object", "properties": { "clusters": { "items": { "$ref": "Cluster" }, "description": "Clusters in the specified location.", "type": "array" }, "nextPageToken": { "type": "string", "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is absent, there are no subsequent pages." }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." } }, "id": "ListClustersResponse", "description": "Response message for ListClusters." }, "ExistingFilestoreConfig": { "id": "ExistingFilestoreConfig", "description": "When set in a StorageResourceConfig, indicates that an existing [Filestore](https://cloud.google.com/filestore) instance should be imported.", "type": "object", "properties": { "filestore": { "type": "string", "description": "Required. Immutable. Name of the Filestore instance to import, in the format `projects/{project}/locations/{location}/instances/{instance}`" } } }, "StorageResourceConfig": { "id": "StorageResourceConfig", "description": "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.", "properties": { "existingFilestore": { "$ref": "ExistingFilestoreConfig", "description": "Optional. Immutable. If set, indicates that an existing Filestore instance should be imported." }, "existingLustre": { "description": "Optional. Immutable. If set, indicates that an existing Managed Lustre instance should be imported.", "$ref": "ExistingLustreConfig" }, "newLustre": { "$ref": "NewLustreConfig", "description": "Optional. Immutable. If set, indicates that a new Managed Lustre instance should be created." }, "existingBucket": { "$ref": "ExistingBucketConfig", "description": "Optional. Immutable. If set, indicates that an existing Cloud Storage bucket should be imported." }, "existingNfs": { "$ref": "ExistingNfsConfig", "description": "Optional. Immutable. If set, indicates that an existing NFS share should be imported." }, "newBucket": { "$ref": "NewBucketConfig", "description": "Optional. Immutable. If set, indicates that a new Cloud Storage bucket should be created." }, "newFilestore": { "description": "Optional. Immutable. If set, indicates that a new Filestore instance should be created.", "$ref": "NewFilestoreConfig" } }, "type": "object" }, "Location": { "type": "object", "properties": { "locationId": { "type": "string", "description": "The canonical id for this location. For example: `\"us-east1\"`." }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object" }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" } }, "id": "Location", "description": "A resource that represents a Google Cloud location." }, "FileShareConfig": { "properties": { "capacityGb": { "format": "int64", "description": "Required. Size of the filestore in GB. Must be between 1024 and 102400, and must meet scalability requirements described at https://cloud.google.com/filestore/docs/service-tiers.", "type": "string" }, "fileShare": { "description": "Required. Filestore share location", "type": "string" } }, "id": "FileShareConfig", "type": "object", "description": "Message describing filestore configuration" }, "Cluster": { "type": "object", "id": "Cluster", "properties": { "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Time that the cluster was most recently updated.", "type": "string" }, "orchestrator": { "$ref": "Orchestrator", "description": "Optional. Orchestrator that is responsible for scheduling and running jobs on the cluster." }, "reconciling": { "type": "boolean", "readOnly": true, "description": "Output only. Indicates whether changes to the cluster are currently in flight. If this is `true`, then the current state might not match the cluster's intended state." }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. [Labels](https://cloud.google.com/compute/docs/labeling-resources) applied to the cluster. Labels can be used to organize clusters and to filter them in queries." }, "name": { "description": "Identifier. [Relative resource name](https://google.aip.dev/122) of the cluster, in the format `projects/{project}/locations/{location}/clusters/{cluster}`.", "type": "string" }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. Time that the cluster was originally created.", "format": "google-datetime" }, "description": { "description": "Optional. A description for your cluster. You can use up to 2,048 characters.", "type": "string" }, "storageResources": { "additionalProperties": { "$ref": "StorageResource" }, "type": "object", "description": "Optional. Storage resources available to the cluster. Keys specify the ID of the storage resource by which it can be referenced elsewhere, and must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters)." }, "computeResources": { "description": "Optional. Compute resources available to the cluster. Keys specify the ID of the compute resource by which it can be referenced elsewhere, and must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters).", "additionalProperties": { "$ref": "ComputeResource" }, "type": "object" }, "uid": { "description": "Output only. The globally unique identifier for this Cluster.", "type": "string", "readOnly": true }, "networkResources": { "description": "Optional. Network resources available to the cluster. Must contain exactly one value. Keys specify the ID of the network resource by which it can be referenced elsewhere, and must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters).", "additionalProperties": { "$ref": "NetworkResource" }, "type": "object" } }, "description": "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." }, "Status": { "id": "Status", "type": "object", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "properties": { "details": { "items": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array" }, "code": { "type": "integer", "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code." }, "message": { "type": "string", "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client." } } }, "NetworkResourceConfig": { "properties": { "existingNetwork": { "$ref": "ExistingNetworkConfig", "description": "Optional. Immutable. If set, indicates that an existing network should be imported." }, "newNetwork": { "description": "Optional. Immutable. If set, indicates that a new network should be created.", "$ref": "NewNetworkConfig" } }, "type": "object", "description": "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.", "id": "NetworkResourceConfig" }, "SlurmOrchestrator": { "description": "When set in Orchestrator, indicates that the cluster should use [Slurm](https://slurm.schedmd.com/) as the orchestrator.", "id": "SlurmOrchestrator", "type": "object", "properties": { "loginNodes": { "description": "Required. Configuration for login nodes, which allow users to access the cluster over SSH.", "$ref": "SlurmLoginNodes" }, "nodeSets": { "items": { "$ref": "SlurmNodeSet" }, "description": "Optional. Compute resource configuration for the Slurm nodesets in your cluster. If not specified, the cluster won't create any nodes.", "type": "array" }, "defaultPartition": { "description": "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.", "type": "string" }, "partitions": { "type": "array", "items": { "$ref": "SlurmPartition" }, "description": "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." }, "prologBashScripts": { "description": "Optional. Slurm [prolog scripts](https://slurm.schedmd.com/prolog_epilog.html), which will be executed by compute nodes before a node begins running a new job. Values must not be empty.", "items": { "type": "string" }, "type": "array" }, "epilogBashScripts": { "items": { "type": "string" }, "type": "array", "description": "Optional. Slurm [epilog scripts](https://slurm.schedmd.com/prolog_epilog.html), which will be executed by compute nodes whenever a node finishes running a job. Values must not be empty." } } }, "CreateStorageBucket": { "description": "When set in OperationStep, indicates that a new storage bucket should be created.", "properties": { "bucket": { "readOnly": true, "type": "string", "description": "Output only. Name of the bucket." } }, "id": "CreateStorageBucket", "type": "object" }, "Operation": { "properties": { "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "metadata": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object" }, "response": { "type": "object", "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } } }, "type": "object", "id": "Operation", "description": "This resource represents a long-running operation that is the result of a network API call." }, "CancelOperationRequest": { "type": "object", "id": "CancelOperationRequest", "description": "The request message for Operations.CancelOperation.", "properties": {} }, "BucketReference": { "description": "A reference to a [Google Cloud Storage](https://cloud.google.com/storage) bucket.", "properties": { "bucket": { "description": "Output only. Name of the bucket.", "readOnly": true, "type": "string" } }, "id": "BucketReference", "type": "object" }, "ExistingNetworkConfig": { "description": "When set in a NetworkResourceConfig, indicates that an existing network should be imported.", "type": "object", "id": "ExistingNetworkConfig", "properties": { "subnetwork": { "description": "Required. Immutable. Particular subnetwork to use, in the format `projects/{project}/regions/{region}/subnetworks/{subnetwork}`.", "type": "string" }, "network": { "type": "string", "description": "Required. Immutable. Name of the network to import, in the format `projects/{project}/global/networks/{network}`." } } }, "NewOnDemandInstancesConfig": { "type": "object", "id": "NewOnDemandInstancesConfig", "description": "When set in a ComputeResourceConfig, indicates that on-demand (i.e., using the standard provisioning model) VM instances should be created.", "properties": { "zone": { "type": "string", "description": "Required. Immutable. Name of the zone in which VM instances 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." }, "machineType": { "type": "string", "description": "Required. Immutable. Name of the Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-resource) to use, e.g. `n2-standard-2`." }, "networkTags": { "description": "Optional. Immutable. A list of network tags to attach to the VM instances. A maximum of 64 network tags are allowed.", "items": { "type": "string" }, "type": "array" } } }, "CreatePrivateServiceAccess": { "id": "CreatePrivateServiceAccess", "properties": {}, "type": "object", "description": "When set in OperationStep, indicates that a new private service access should be created." }, "StorageResource": { "properties": { "bucket": { "$ref": "BucketReference", "description": "Output only. A reference to a Google Cloud Storage bucket. Populated if and only if the storage resource was configured to use Google Cloud Storage.", "readOnly": true }, "lustre": { "description": "Output only. A reference to a Managed Lustre instance. Populated if and only if the storage resource was configured to use Managed Lustre.", "$ref": "LustreReference", "readOnly": true }, "filestore": { "$ref": "FilestoreReference", "readOnly": true, "description": "Output only. A reference to a Filestore instance. Populated if and only if the storage resource was configured to use Filestore." }, "config": { "$ref": "StorageResourceConfig", "description": "Required. Immutable. Configuration for this storage resource, which describes how it should be created or imported. This field only controls how the storage resource is initially created or imported. Subsequent changes to the storage resource should be made via the resource's API and will not be reflected in the configuration." } }, "id": "StorageResource", "description": "Represents a form of persistent storage that you can mount onto compute resources in the cluster.", "type": "object" }, "DeletePrivateServiceAccess": { "description": "When set in OperationStep, indicates private service access deletion step.", "type": "object", "id": "DeletePrivateServiceAccess", "properties": {} }, "NewReservedInstancesConfig": { "properties": { "networkTags": { "type": "array", "description": "Optional. Immutable. A list of network tags to attach to the VM instances. A maximum of 64 network tags are allowed.", "items": { "type": "string" } }, "reservation": { "type": "string", "description": "Optional. Immutable. Name of the reservation from which VM instances should be created, in the format `projects/{project}/zones/{zone}/reservations/{reservation}`." }, "reservationSubBlock": { "description": "Optional. Immutable. Name of the reservation sub block from which VM instances should be created, in the format `projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservation_block}/reservationSubBlocks/{reservation_sub_block}`.", "type": "string" }, "reservationBlock": { "description": "Optional. Immutable. Name of the reservation block from which VM instances should be created, in the format `projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservation_block}`.", "type": "string" } }, "id": "NewReservedInstancesConfig", "type": "object", "description": "When set in a ComputeResourceConfig, indicates that VM instances should be created from a [reservation](https://cloud.google.com/compute/docs/instances/reservations-overview)." }, "NewLustreConfig": { "type": "object", "description": "When set in a StorageResourceConfig, indicates that a new [Managed Lustre](https://cloud.google.com/products/managed-lustre) instance should be created.", "id": "NewLustreConfig", "properties": { "description": { "description": "Optional. Immutable. Description of the Managed Lustre instance. Maximum of 2048 characters.", "type": "string" }, "filesystem": { "type": "string", "description": "Required. Immutable. Filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be 8 characters or less and can only contain letters and numbers." }, "lustre": { "description": "Required. Immutable. Name of the Managed Lustre instance to create, in the format `projects/{project}/locations/{location}/instances/{instance}`", "type": "string" }, "perUnitStorageThroughput": { "type": "string", "format": "int64", "description": "Optional. Immutable. Throughput of the instance in MB/s/TiB. Valid values are 125, 250, 500, 1000. See [Performance tiers and maximum storage capacities](https://cloud.google.com/managed-lustre/docs/create-instance#performance-tiers) for more information." }, "capacityGb": { "description": "Required. Immutable. Storage capacity of the instance in gibibytes (GiB). Allowed values are between 18000 and 7632000.", "type": "string", "format": "int64" } } }, "ExistingLustreConfig": { "type": "object", "properties": { "lustre": { "type": "string", "description": "Required. Immutable. Name of the Managed Lustre instance to import, in the format `projects/{project}/locations/{location}/instances/{instance}`" } }, "description": "When set in a StorageResourceConfig, indicates that an existing [Managed Lustre](https://cloud.google.com/products/managed-lustre) instance should be imported.", "id": "ExistingLustreConfig" }, "StorageConfig": { "type": "object", "id": "StorageConfig", "properties": { "localMount": { "description": "Required. A directory inside the VM instance's file system where the storage resource should be mounted (e.g., `/mnt/share`).", "type": "string" }, "id": { "description": "Required. ID of the storage resource to mount, which must match a key in the cluster's storage_resources.", "type": "string" } }, "description": "Description of how a storage resource should be mounted on a VM instance." }, "NewFlexStartInstancesConfig": { "id": "NewFlexStartInstancesConfig", "properties": { "zone": { "type": "string", "description": "Required. Immutable. Name of the zone in which VM instances 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." }, "machineType": { "description": "Required. Immutable. Name of the Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-resource) to use, e.g. `n2-standard-2`.", "type": "string" }, "maxDuration": { "description": "Required. Immutable. Specifies the time limit for created instances. Instances will be terminated at the end of this duration.", "type": "string", "format": "google-duration" }, "networkTags": { "items": { "type": "string" }, "description": "Optional. Immutable. A list of network tags to attach to the VM instances. A maximum of 64 network tags are allowed.", "type": "array" } }, "description": "When set in a ComputeResourceConfig, indicates that VM instances should be created using [Flex Start](https://cloud.google.com/compute/docs/instances/provisioning-models).", "type": "object" }, "GcsHierarchicalNamespaceConfig": { "type": "object", "properties": { "enabled": { "description": "Required. Enables hierarchical namespace setup for the bucket.", "type": "boolean" } }, "id": "GcsHierarchicalNamespaceConfig", "description": "Message describing Google Cloud Storage hierarchical namespace configuration" }, "DeleteLustreInstance": { "properties": { "lustre": { "type": "string", "description": "Output only. Name of the Managed Lustre instance, in the format `projects/{project}/locations/{location}/instances/{instance}`", "readOnly": true } }, "type": "object", "id": "DeleteLustreInstance", "description": "When set in OperationStep, indicates that a Lustre instance should be deleted." }, "DeleteFilestoreInstance": { "properties": { "filestore": { "type": "string", "description": "Output only. Name of the Filestore instance, in the format `projects/{project}/locations/{location}/instances/{instance}`", "readOnly": true } }, "type": "object", "id": "DeleteFilestoreInstance", "description": "When set in OperationStep, indicates that a Filestore instance should be deleted." }, "OperationMetadata": { "type": "object", "properties": { "apiVersion": { "readOnly": true, "description": "Output only. API version used to start the operation.", "type": "string" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "requestedCancellation": { "type": "boolean", "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "readOnly": true }, "progress": { "$ref": "OperationProgress", "description": "Output only. Progress of the operation.", "readOnly": true }, "verb": { "readOnly": true, "description": "Output only. Name of the verb executed by the operation.", "type": "string" }, "target": { "readOnly": true, "type": "string", "description": "Output only. Server-defined resource path for the target of the operation." } }, "id": "OperationMetadata", "description": "Represents the metadata of the long-running operation." }, "CheckClusterHealth": { "description": "When set in OperationStep, indicates that cluster health check should be performed.", "properties": {}, "type": "object", "id": "CheckClusterHealth" }, "DeleteOrchestrator": { "id": "DeleteOrchestrator", "properties": {}, "type": "object", "description": "When set in OperationStep, indicates that an orchestrator should be deleted." }, "SlurmNodeDetails": { "type": "object", "id": "SlurmNodeDetails", "description": "Slurm-specific details for a Node.", "properties": { "comment": { "description": "Output only. System comments from Slurm.", "type": "string", "readOnly": true }, "reason": { "description": "Output only. User-readable reason for the current state.", "readOnly": true, "type": "string" }, "states": { "items": { "type": "string" }, "type": "array", "description": "Output only. Raw state flags directly from Slurm.", "readOnly": true }, "nodeset": { "readOnly": true, "type": "string", "description": "Output only. The ID of the nodeset this node belongs to." }, "partitions": { "items": { "type": "string" }, "description": "Output only. Slurm partitions this node belongs to.", "type": "array", "readOnly": true } } }, "CreateOrchestrator": { "properties": {}, "description": "When set in OperationStep, indicates that an orchestrator should be created.", "id": "CreateOrchestrator", "type": "object" }, "NetworkResource": { "id": "NetworkResource", "type": "object", "description": "A resource representing a network that connects the various components of a cluster together.", "properties": { "network": { "description": "Output only. A reference to a network in Google Compute Engine.", "readOnly": true, "$ref": "NetworkReference" }, "config": { "$ref": "NetworkResourceConfig", "description": "Immutable. Configuration for this network resource, which describes how it should be created or imported. This field only controls how the network resource is initially created or imported. Subsequent changes to the network resource should be made via the resource's API and will not be reflected in the configuration." } } }, "SlurmNodeSet": { "type": "object", "description": "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.", "id": "SlurmNodeSet", "properties": { "storageConfigs": { "items": { "$ref": "StorageConfig" }, "type": "array", "description": "Optional. How storage resources should be mounted on each compute node." }, "maxDynamicNodeCount": { "type": "string", "format": "int64", "description": "Optional. Controls how many additional nodes a cluster can bring online to handle workloads. Set this value to enable dynamic node creation and limit the number of additional nodes the cluster can bring online. Leave empty if you do not want the cluster to create nodes dynamically, and instead rely only on static nodes." }, "staticNodeCount": { "format": "int64", "type": "string", "description": "Optional. Number of nodes to be statically created for this nodeset. The cluster will attempt to ensure that at least this many nodes exist at all times." }, "id": { "type": "string", "description": "Required. The ID for the nodeset, which allows it to be referenced by cluster partitions. The nodeset ID must start with a lowercase letter (`a`-`z`), use only lowercase letters or numbers, and contain up to 15 characters. For example, specify `nodeset001`." }, "computeInstance": { "description": "Optional. If set, indicates that the nodeset should be backed by Compute Engine instances.", "$ref": "ComputeInstanceSlurmNodeSet" }, "computeId": { "type": "string", "description": "Required. The ID of the compute resource on which this nodeset runs. Must match a key in the cluster's compute_resources." } } }, "ComputeInstance": { "type": "object", "properties": { "instance": { "readOnly": true, "description": "Output only. Name of the VM instance, in the format `projects/{project}/zones/{zone}/instances/{instance}`.", "type": "string" } }, "description": "Details about a Compute Engine [instance](https://cloud.google.com/compute/docs/instances).", "id": "ComputeInstance" }, "NewSpotInstancesConfig": { "id": "NewSpotInstancesConfig", "description": "When set in a ComputeResourceConfig, indicates that [spot VM](https://cloud.google.com/compute/docs/instances/spot) instances should be created.", "properties": { "terminationAction": { "type": "string", "description": "Optional. Termination action for the instance. If not specified, Compute Engine sets the termination action to DELETE.", "enum": [ "TERMINATION_ACTION_UNSPECIFIED", "STOP", "DELETE" ], "enumDescriptions": [ "Not set.", "Compute Engine stops the Spot VM on preemption.", "Compute Engine deletes the Spot VM on preemption." ] }, "zone": { "description": "Required. Immutable. Name of the zone in which VM instances 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.", "type": "string" }, "machineType": { "type": "string", "description": "Required. Immutable. Name of the Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-resource) to use, e.g. `n2-standard-2`." }, "networkTags": { "items": { "type": "string" }, "type": "array", "description": "Optional. Immutable. A list of network tags to attach to the VM instances. A maximum of 64 network tags are allowed." } }, "type": "object" }, "CreateLoginNode": { "description": "When set in OperationStep, indicates that a login node should be created.", "type": "object", "id": "CreateLoginNode", "properties": {} }, "ComputeInstanceSlurmNodeSet": { "type": "object", "id": "ComputeInstanceSlurmNodeSet", "description": "When set in a SlurmNodeSet, indicates that the nodeset should be backed by Compute Engine VM instances.", "properties": { "bootDisk": { "description": "Optional. Boot disk for the compute instance", "$ref": "BootDisk" }, "startupScript": { "type": "string", "description": "Optional. [Startup script](https://cloud.google.com/compute/docs/instances/startup-scripts/linux) to be run on each VM instance in the nodeset. Max 256KB." }, "labels": { "type": "object", "description": "Optional. [Labels](https://cloud.google.com/compute/docs/labeling-resources) that should be applied to each VM instance in the nodeset.", "additionalProperties": { "type": "string" } } } }, "CreateFilestoreInstance": { "type": "object", "id": "CreateFilestoreInstance", "description": "When set in OperationStep, indicates that a new filestore instance should be created.", "properties": { "filestore": { "readOnly": true, "type": "string", "description": "Output only. Name of the Filestore instance, in the format `projects/{project}/locations/{location}/instances/{instance}`" } } }, "UpdateOrchestrator": { "type": "object", "properties": {}, "description": "When set in OperationStep, indicates that an orchestrator should be updated.", "id": "UpdateOrchestrator" }, "DeleteStorageBucket": { "properties": { "bucket": { "description": "Output only. Name of the bucket.", "type": "string", "readOnly": true } }, "description": "When set in OperationStep, indicates that Cloud Storage bucket should be deleted.", "type": "object", "id": "DeleteStorageBucket" }, "DeleteNetwork": { "description": "When set in OperationStep, indicates network deletion step with the resource name.", "type": "object", "id": "DeleteNetwork", "properties": { "network": { "readOnly": true, "description": "Output only. Name of the network to delete, in the format `projects/{project}/global/networks/{network}`.", "type": "string" } } }, "ComputeResourceConfig": { "description": "Describes how a compute resource should be created at runtime.", "id": "ComputeResourceConfig", "properties": { "newOnDemandInstances": { "$ref": "NewOnDemandInstancesConfig", "description": "Optional. Immutable. If set, indicates that this resource should use on-demand VMs." }, "newReservedInstances": { "$ref": "NewReservedInstancesConfig", "description": "Optional. Immutable. If set, indicates that this resource should use reserved VMs." }, "newFlexStartInstances": { "description": "Optional. Immutable. If set, indicates that this resource should use flex-start VMs.", "$ref": "NewFlexStartInstancesConfig" }, "newSpotInstances": { "$ref": "NewSpotInstancesConfig", "description": "Optional. Immutable. If set, indicates that this resource should use spot VMs." } }, "type": "object" }, "ComputeEngineNodeDetails": { "type": "object", "properties": { "instance": { "type": "string", "readOnly": true, "description": "Output only. [Relative resource name](https://google.aip.dev/122) of the VM instance, in the format `projects/{project}/zones/{zone}/instances/{instance}`." }, "instanceGroupManager": { "description": "Output only. [Relative resource name](https://google.aip.dev/122) of the managed instance group, in the format `projects/{project}/zones/{zone}/instanceGroupManagers/{instance_group_manager}`. or `projects/{project}/regions/{region}/instanceGroupManagers/{instance_group_manager}`", "type": "string", "readOnly": true }, "state": { "type": "string", "readOnly": true, "description": "Output only. The Compute Engine VM [instance lifecycle state](https://cloud.google.com/compute/docs/instances/instance-lifecycle)." }, "machineType": { "type": "string", "readOnly": true, "description": "Output only. Name of the Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-resource) to use, e.g. `n2-standard-2`." } }, "id": "ComputeEngineNodeDetails", "description": "Compute Engine-specific details for a Node." }, "DeleteNodeset": { "type": "object", "id": "DeleteNodeset", "description": "When set in OperationStep, indicates that a nodeset should be deleted.", "properties": { "nodesets": { "description": "Output only. Name of the nodeset to delete", "items": { "type": "string" }, "type": "array", "readOnly": true } } } }, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "revision": "20260909", "kind": "discovery#restDescription", "rootUrl": "https://hypercomputecluster.googleapis.com/", "servicePath": "", "protocol": "rest", "documentationLink": "https://docs.cloud.google.com/cluster-director/docs", "baseUrl": "https://hypercomputecluster.googleapis.com/", "mtlsRootUrl": "https://hypercomputecluster.mtls.googleapis.com/", "id": "hypercomputecluster:v1beta" }