-
Notifications
You must be signed in to change notification settings - Fork 440
feat(hypercomputecluster): generate library #16013
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
scotthart
merged 5 commits into
googleapis:main
from
scotthart:feat-hypercomputecluster-generate-library
Feb 27, 2026
+6,721
−0
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
aabdb50
feat(hypercomputecluster): generate library
scotthart 7956415
Run generators and format their outputs
scotthart aa47cdb
Add API baseline
scotthart ff7154f
disambiguate hypercomputecluster from compute libraries
scotthart 35d269a
Manually update READMEs, quickstart, and top-level stuff
scotthart File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -317,6 +317,9 @@ See each library's `README.md` file for more information about: | |
| - [GKE Recommender API](google/cloud/gkerecommender/README.md) | ||
| [[quickstart]](google/cloud/gkerecommender/quickstart/README.md) | ||
| [[reference]](https://cloud.google.com/cpp/docs/reference/gkerecommender/latest) | ||
| - [Cluster Director API](google/cloud/hypercomputecluster/README.md) | ||
| [[quickstart]](google/cloud/hypercomputecluster/quickstart/README.md) | ||
| [[reference]](https://cloud.google.com/cpp/docs/reference/hypercomputecluster/latest) | ||
|
Comment on lines
+320
to
+322
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| - [Google Cloud IAM](google/cloud/iam/README.md) | ||
| [[quickstart]](google/cloud/iam/quickstart/README.md) | ||
| [[reference]](https://cloud.google.com/cpp/docs/reference/iam/latest) | ||
|
|
||
Binary file added
BIN
+653 KB
ci/abi-dumps/google_cloud_cpp_hypercomputecluster.expected.abi.dump.gz
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| @googleapis//google/api:annotations_proto | ||
| @googleapis//google/api:client_proto | ||
| @googleapis//google/api:field_behavior_proto | ||
| @googleapis//google/api:field_info_proto | ||
| @googleapis//google/api:http_proto | ||
| @googleapis//google/api:launch_stage_proto | ||
| @googleapis//google/api:resource_proto | ||
| @googleapis//google/longrunning:operations_proto | ||
| @googleapis//google/rpc:status_proto |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| @googleapis//google/cloud/hypercomputecluster/v1:hypercompute_cluster.proto | ||
| @googleapis//google/cloud/hypercomputecluster/v1:operation_metadata.proto |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2664,6 +2664,14 @@ service { | |
| retryable_status_codes: ["kUnavailable"] | ||
| } | ||
|
|
||
| # Hypercompute Cluster | ||
| service { | ||
| service_proto_path: "google/cloud/hypercomputecluster/v1/hypercompute_cluster.proto" | ||
| product_path: "google/cloud/hypercomputecluster/v1" | ||
| initial_copyright_year: "2026" | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| retryable_status_codes: ["kUnavailable"] | ||
| } | ||
|
|
||
| # IAM | ||
| service { | ||
| service_proto_path: "google/iam/credentials/v1/iamcredentials.proto" | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # Copyright 2026 Google LLC | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| load("//bazel:gapic.bzl", "cc_gapic_library") | ||
|
|
||
| package(default_visibility = ["//visibility:private"]) | ||
|
|
||
| licenses(["notice"]) # Apache 2.0 | ||
|
|
||
| service_dirs = ["v1/"] | ||
|
|
||
| googleapis_deps = [ | ||
| "@googleapis//google/cloud/hypercomputecluster/v1:hypercomputecluster_cc_grpc", | ||
| ] | ||
|
|
||
| cc_gapic_library( | ||
| name = "hypercomputecluster", | ||
| googleapis_deps = googleapis_deps, | ||
| service_dirs = service_dirs, | ||
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # ~~~ | ||
| # Copyright 2026 Google LLC | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| # ~~~ | ||
|
|
||
| include(GoogleCloudCppLibrary) | ||
|
|
||
| google_cloud_cpp_add_gapic_library(hypercomputecluster "Cluster Director API" | ||
| SERVICE_DIRS "v1/") | ||
|
|
||
| if (BUILD_TESTING AND GOOGLE_CLOUD_CPP_ENABLE_CXX_EXCEPTIONS) | ||
| add_executable(hypercomputecluster_quickstart "quickstart/quickstart.cc") | ||
| target_link_libraries(hypercomputecluster_quickstart | ||
| PRIVATE google-cloud-cpp::hypercomputecluster) | ||
| google_cloud_cpp_add_common_options(hypercomputecluster_quickstart) | ||
| add_test( | ||
| NAME hypercomputecluster_quickstart | ||
| COMMAND | ||
| cmake -P "${PROJECT_SOURCE_DIR}/cmake/quickstart-runner.cmake" | ||
| $<TARGET_FILE:hypercomputecluster_quickstart> GOOGLE_CLOUD_PROJECT | ||
| GOOGLE_CLOUD_CPP_TEST_REGION) | ||
| set_tests_properties( | ||
| hypercomputecluster_quickstart | ||
| PROPERTIES LABELS "integration-test;quickstart" PASS_REGULAR_EXPRESSION | ||
| "Permanent error.*gcloud-cpp.retry.function=ListClusters") | ||
| endif () |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| # Cluster Director API C++ Client Library | ||
|
|
||
| This directory contains an idiomatic C++ client library for the | ||
| [Cluster Director API][cloud-service-docs]. | ||
|
|
||
| The Cluster Director API allows you to deploy, manage, and monitor clusters that | ||
| run AI, ML, or HPC workloads. | ||
|
|
||
| While this library is **GA**, please note that the Google Cloud C++ client | ||
| libraries do **not** follow [Semantic Versioning](https://semver.org/). | ||
|
|
||
| ## Quickstart | ||
|
|
||
| The [quickstart/](quickstart/README.md) directory contains a minimal environment | ||
| to get started using this client library in a larger project. The following | ||
| "Hello World" program is used in this quickstart, and should give you a taste of | ||
| this library. | ||
|
|
||
| <!-- inject-quickstart-start --> | ||
|
|
||
| ```cc | ||
| #include "google/cloud/hypercomputecluster/v1/hypercompute_cluster_client.h" | ||
| #include "google/cloud/location.h" | ||
| #include <iostream> | ||
|
|
||
| int main(int argc, char* argv[]) try { | ||
| if (argc != 3) { | ||
| std::cerr << "Usage: " << argv[0] << " project-id location-id\n"; | ||
| return 1; | ||
| } | ||
|
|
||
| auto const location = google::cloud::Location(argv[1], argv[2]); | ||
|
|
||
| namespace hypercomputecluster = ::google::cloud::hypercomputecluster_v1; | ||
| auto client = hypercomputecluster::HypercomputeClusterClient( | ||
| hypercomputecluster::MakeHypercomputeClusterConnection()); | ||
|
|
||
| for (auto r : client.ListClusters(location.FullName())) { | ||
| if (!r) throw std::move(r).status(); | ||
| std::cout << r->DebugString() << "\n"; | ||
| } | ||
|
|
||
| return 0; | ||
| } catch (google::cloud::Status const& status) { | ||
| std::cerr << "google::cloud::Status thrown: " << status << "\n"; | ||
| return 1; | ||
| } | ||
| ``` | ||
|
|
||
| <!-- inject-quickstart-end --> | ||
|
|
||
| ## More Information | ||
|
|
||
| - Official documentation about the [Cluster Director API][cloud-service-docs] | ||
| service | ||
| - [Reference doxygen documentation][doxygen-link] for each release of this | ||
| client library | ||
| - Detailed header comments in our [public `.h`][source-link] files | ||
|
|
||
| [cloud-service-docs]: https://cloud.google.com/cluster-director/docs | ||
| [doxygen-link]: https://cloud.google.com/cpp/docs/reference/hypercomputecluster/latest/ | ||
| [source-link]: https://github.com/googleapis/google-cloud-cpp/tree/main/google/cloud/hypercomputecluster |
49 changes: 49 additions & 0 deletions
49
google/cloud/hypercomputecluster/doc/environment-variables.dox
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| /*! | ||
| @page hypercomputecluster-env Environment Variables | ||
|
|
||
| A number of environment variables can be used to configure the behavior of | ||
| the library. There are also functions to configure this behavior in code. The | ||
| environment variables are convenient when troubleshooting problems. | ||
|
|
||
| @section hypercomputecluster-env-endpoint Endpoint Overrides | ||
|
|
||
| <!-- inject-endpoint-env-vars-start --> | ||
|
|
||
| - `GOOGLE_CLOUD_CPP_HYPERCOMPUTE_CLUSTER_ENDPOINT=...` overrides the | ||
| `EndpointOption` (which defaults to "hypercomputecluster.googleapis.com") | ||
| used by `MakeHypercomputeClusterConnection()`. | ||
|
|
||
| <!-- inject-endpoint-env-vars-end --> | ||
|
|
||
| @see google::cloud::EndpointOption | ||
|
|
||
| @section hypercomputecluster-env-logging Logging | ||
|
|
||
| `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc`: turns on tracing for most gRPC | ||
| calls. The library injects an additional Stub decorator that prints each gRPC | ||
| request and response. Unless you have configured your own logging backend, | ||
| you should also set `GOOGLE_CLOUD_CPP_ENABLE_CLOG` to produce any output on | ||
| the program's console. | ||
|
|
||
| @see google::cloud::LoggingComponentsOption | ||
|
|
||
| `GOOGLE_CLOUD_CPP_TRACING_OPTIONS=...`: modifies the behavior of gRPC tracing, | ||
| including whether messages will be output on multiple lines, or whether | ||
| string/bytes fields will be truncated. | ||
|
|
||
| @see google::cloud::GrpcTracingOptionsOption | ||
|
|
||
| `GOOGLE_CLOUD_CPP_ENABLE_CLOG=yes`: turns on logging in the library, basically | ||
| the library always "logs" but the logging infrastructure has no backend to | ||
| actually print anything until the application sets a backend or they set this | ||
| environment variable. | ||
|
|
||
| @see google::cloud::LogBackend | ||
| @see google::cloud::LogSink | ||
|
|
||
| @section hypercomputecluster-env-project Setting the Default Project | ||
|
|
||
| `GOOGLE_CLOUD_PROJECT=...`: is used in examples and integration tests to | ||
| configure the GCP project. This has no effect in the library. | ||
|
|
||
| */ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| /*! | ||
|
|
||
| @mainpage Cluster Director API C++ Client Library | ||
|
|
||
| An idiomatic C++ client library for the [Cluster Director API][cloud-service-docs]. | ||
|
|
||
| The Cluster Director API allows you to deploy, manage, and monitor clusters | ||
| that run AI, ML, or HPC workloads. | ||
|
|
||
| While this library is **GA**, please note that the Google Cloud C++ client libraries do **not** follow | ||
| [Semantic Versioning](https://semver.org/). | ||
|
|
||
| @tableofcontents{HTML:2} | ||
|
|
||
| ## Quickstart | ||
|
|
||
| The following shows the code that you'll run in the | ||
| `google/cloud/hypercomputecluster/quickstart/` directory, | ||
| which should give you a taste of the Cluster Director API C++ client library API. | ||
|
|
||
| @snippet quickstart.cc all | ||
|
|
||
| ## Main classes | ||
|
|
||
| <!-- inject-client-list-start --> | ||
| The main class in this library is | ||
| [`hypercomputecluster_v1::HypercomputeClusterClient`](@ref google::cloud::hypercomputecluster_v1::HypercomputeClusterClient). All RPCs are exposed | ||
| as member functions of this class. Other classes provide helpers, configuration | ||
| parameters, and infrastructure to mock | ||
| [`hypercomputecluster_v1::HypercomputeClusterClient`](@ref google::cloud::hypercomputecluster_v1::HypercomputeClusterClient) when testing your | ||
| application. | ||
| <!-- inject-client-list-end --> | ||
|
|
||
| ## More Information | ||
|
|
||
| - @ref common-error-handling - describes how the library reports errors. | ||
| - @ref hypercomputecluster-override-endpoint - describes how to override the default | ||
| endpoint. | ||
| - @ref hypercomputecluster-override-authentication - describes how to change the | ||
| authentication credentials used by the library. | ||
| - @ref hypercomputecluster-override-retry - describes how to change the default retry | ||
| policies. | ||
| - @ref hypercomputecluster-env - describes environment variables that can configure the | ||
| behavior of the library. | ||
| - @ref hypercomputecluster-override-universe-domain - describes how to override the default universe domain. | ||
|
|
||
| [cloud-service-docs]: https://cloud.google.com/cluster-director/docs | ||
|
|
||
| */ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| /*! | ||
| @defgroup google-cloud-hypercomputecluster-options Cluster Director API Configuration Options | ||
|
|
||
| This library uses the same mechanism (`google::cloud::Options`) and the common | ||
| [options](@ref options) as all other C++ client libraries for its configuration. | ||
| Some `*Option` classes, which are only used in this library, are documented in | ||
| this page. | ||
|
|
||
| @see @ref options - for an overview of client library configuration. | ||
| */ |
35 changes: 35 additions & 0 deletions
35
google/cloud/hypercomputecluster/doc/override-authentication.dox
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| /*! | ||
| @page hypercomputecluster-override-authentication How to Override the Authentication Credentials | ||
|
|
||
| Unless otherwise configured, the client libraries use | ||
| [Application Default Credentials] to authenticate with Google Cloud Services. | ||
| While this works for most applications, in some cases you may need to override | ||
| this default. You can do so by providing the | ||
| [UnifiedCredentialsOption](@ref google::cloud::UnifiedCredentialsOption) | ||
| The following example shows how to explicitly load a service account key file: | ||
|
|
||
| <!-- inject-service-account-snippet-start --> | ||
| @snippet hypercompute_cluster_client_samples.cc with-service-account | ||
|
|
||
| <!-- inject-service-account-snippet-end --> | ||
|
|
||
| Keep in mind that we chose this as an example because it is relatively easy to | ||
| understand. Consult the [Best practices for managing service account keys] | ||
| guide for more details. | ||
|
|
||
| @see @ref guac - for more information on the factory functions to create | ||
| `google::cloud::Credentials` objects. | ||
|
|
||
| [Best practices for managing service account keys]: https://cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys | ||
| [Application Default Credentials]: https://cloud.google.com/docs/authentication#adc | ||
|
|
||
| */ | ||
|
|
||
| // <!-- inject-authentication-pages-start --> | ||
|
|
||
| /*! @page hypercomputecluster_v1::HypercomputeClusterClient-service-account-snippet Override hypercomputecluster_v1::HypercomputeClusterClient Authentication Defaults | ||
|
|
||
| @snippet google/cloud/hypercomputecluster/v1/samples/hypercompute_cluster_client_samples.cc with-service-account | ||
|
|
||
| */ | ||
| // <!-- inject-authentication-pages-end --> |
25 changes: 25 additions & 0 deletions
25
google/cloud/hypercomputecluster/doc/override-endpoint.dox
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| /*! | ||
| @page hypercomputecluster-override-endpoint How to Override the Default Endpoint | ||
|
|
||
| In some cases, you may need to override the default endpoint used by the client | ||
| library. Use the | ||
| [EndpointOption](@ref google::cloud::EndpointOption) when initializing the | ||
| client library to change this default. | ||
|
|
||
| <!-- inject-endpoint-snippet-start --> | ||
| For example, this will override the default endpoint for `hypercomputecluster_v1::HypercomputeClusterClient`: | ||
|
|
||
| @snippet hypercompute_cluster_client_samples.cc set-client-endpoint | ||
|
|
||
| <!-- inject-endpoint-snippet-end --> | ||
|
|
||
| */ | ||
|
|
||
| // <!-- inject-endpoint-pages-start --> | ||
|
|
||
| /*! @page hypercomputecluster_v1::HypercomputeClusterClient-endpoint-snippet Override hypercomputecluster_v1::HypercomputeClusterClient Endpoint Configuration | ||
|
|
||
| @snippet google/cloud/hypercomputecluster/v1/samples/hypercompute_cluster_client_samples.cc set-client-endpoint | ||
|
|
||
| */ | ||
| // <!-- inject-endpoint-pages-end --> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To maintain alphabetical order in this list, this new entry for "Cluster Director API" should be placed before "Gemini Enterprise for Customer Experience API".