Skip to content

Commit a2aaac6

Browse files
authored
feat: introduce HypercomputeCluster (#8788)
1 parent 49c0e47 commit a2aaac6

File tree

73 files changed

+9845
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+9845
-0
lines changed

.repo-metadata-full.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -823,6 +823,14 @@
823823
"library_type": "GAPIC_AUTO",
824824
"api_shortname": "containeranalysis"
825825
},
826+
"HypercomputeCluster": {
827+
"language": "php",
828+
"distribution_name": "google/cloud-hypercomputecluster",
829+
"release_level": "preview",
830+
"client_documentation": "https://cloud.google.com/php/docs/reference/cloud-hypercomputecluster/latest",
831+
"library_type": "GAPIC_AUTO",
832+
"api_shortname": "hypercomputecluster"
833+
},
826834
"Iam": {
827835
"language": "php",
828836
"distribution_name": "google/cloud-iam",

HypercomputeCluster/.OwlBot.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
deep-copy-regex:
2+
- source: /google/cloud/hypercomputecluster/(v1beta)/.*-php/(.*)
3+
dest: /owl-bot-staging/HypercomputeCluster/$1/$2
4+
api-name: HypercomputeCluster

HypercomputeCluster/.gitattributes

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
/*.xml.dist export-ignore
2+
/.OwlBot.yaml export-ignore
3+
/.github export-ignore
4+
/owlbot.py export-ignore
5+
/src/**/gapic_metadata.json export-ignore
6+
/samples export-ignore
7+
/tests export-ignore
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
**PLEASE READ THIS ENTIRE MESSAGE**
2+
3+
Hello, and thank you for your contribution! Please note that this repository is
4+
a read-only split of `googleapis/google-cloud-php`. As such, we are
5+
unable to accept pull requests to this repository.
6+
7+
We welcome your pull request and would be happy to consider it for inclusion in
8+
our library if you follow these steps:
9+
10+
* Clone the parent client library repository:
11+
12+
```sh
13+
$ git clone git@github.com:googleapis/google-cloud-php.git
14+
```
15+
16+
* Move your changes into the correct location in that library. Library code
17+
belongs in `HypercomputeCluster/src`, and tests in `HypercomputeCluster/tests`.
18+
19+
* Push the changes in a new branch to a fork, and open a new pull request
20+
[here](https://github.com/googleapis/google-cloud-php).
21+
22+
Thanks again, and we look forward to seeing your proposed change!
23+
24+
The Google Cloud PHP team
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# How to Contribute
2+
3+
We'd love to accept your patches and contributions to this project. We accept
4+
and review pull requests against the main
5+
[Google Cloud PHP](https://github.com/googleapis/google-cloud-php)
6+
repository, which contains all of our client libraries. You will also need to
7+
sign a Contributor License Agreement. For more details about how to contribute,
8+
see the
9+
[CONTRIBUTING.md](https://github.com/googleapis/google-cloud-php/blob/main/CONTRIBUTING.md)
10+
file in the main Google Cloud PHP repository.

HypercomputeCluster/LICENSE

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright {yyyy} {name of copyright owner}
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.
202+

HypercomputeCluster/README.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Google Cloud Hypercompute Cluster for PHP
2+
3+
> Idiomatic PHP client for [Google Cloud Hypercompute Cluster](https://cloud.google.com/blog/products/compute/managed-slurm-and-other-cluster-director-enhancements).
4+
5+
[![Latest Stable Version](https://poser.pugx.org/google/cloud-hypercomputecluster/v/stable)](https://packagist.org/packages/google/cloud-hypercomputecluster) [![Packagist](https://img.shields.io/packagist/dm/google/cloud-hypercomputecluster.svg)](https://packagist.org/packages/google/cloud-hypercomputecluster)
6+
7+
* [API documentation](https://cloud.google.com/php/docs/reference/cloud-hypercomputecluster/latest)
8+
9+
**NOTE:** This repository is part of [Google Cloud PHP](https://github.com/googleapis/google-cloud-php). Any
10+
support requests, bug reports, or development contributions should be directed to
11+
that project.
12+
13+
### Installation
14+
15+
To begin, install the preferred dependency manager for PHP, [Composer](https://getcomposer.org/).
16+
17+
Now, install this component:
18+
19+
```sh
20+
$ composer require google/cloud-hypercomputecluster
21+
```
22+
23+
> Browse the complete list of [Google Cloud APIs](https://cloud.google.com/php/docs/reference)
24+
> for PHP
25+
26+
This component supports both REST over HTTP/1.1 and gRPC. In order to take advantage of the benefits
27+
offered by gRPC (such as streaming methods) please see our
28+
[gRPC installation guide](https://cloud.google.com/php/grpc).
29+
30+
### Authentication
31+
32+
Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information
33+
on authenticating your client. Once authenticated, you'll be ready to start making requests.
34+
35+
### Sample
36+
37+
```php
38+
use Google\ApiCore\ApiException;
39+
use Google\Cloud\HypercomputeCluster\V1beta\Client\HypercomputeClusterClient;
40+
use Google\Cloud\HypercomputeCluster\V1beta\Cluster;
41+
use Google\Cloud\HypercomputeCluster\V1beta\GetClusterRequest;
42+
43+
// Create a client.
44+
$hypercomputeClusterClient = new HypercomputeClusterClient();
45+
46+
// Prepare the request message.
47+
$request = (new GetClusterRequest())
48+
->setName($formattedName);
49+
50+
// Call the API and handle any network failures.
51+
try {
52+
/** @var Cluster $response */
53+
$response = $hypercomputeClusterClient->getCluster($request);
54+
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
55+
} catch (ApiException $ex) {
56+
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
57+
}
58+
```
59+
60+
See the [samples directory](https://github.com/googleapis/google-cloud-php-hypercomputecluster/tree/main/samples) for a canonical list of samples.
61+
62+
### Debugging
63+
64+
Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md)
65+
for more information about the debugging tools.
66+
67+
### Version
68+
69+
This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates.
70+
71+
### Next Steps
72+
73+
1. Understand the [official documentation](https://cloud.google.com/blog/products/compute/managed-slurm-and-other-cluster-director-enhancements).

HypercomputeCluster/VERSION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
0.0.0

HypercomputeCluster/composer.json

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"name": "google/cloud-hypercomputecluster",
3+
"description": "Google Cloud Hypercompute Cluster Client for PHP",
4+
"license": "Apache-2.0",
5+
"minimum-stability": "stable",
6+
"autoload": {
7+
"psr-4": {
8+
"Google\\Cloud\\HypercomputeCluster\\": "src",
9+
"GPBMetadata\\Google\\Cloud\\Hypercomputecluster\\": "metadata"
10+
}
11+
},
12+
"extra": {
13+
"component": {
14+
"id": "cloud-hypercomputecluster",
15+
"path": "HypercomputeCluster",
16+
"target": "googleapis/google-cloud-php-hypercomputecluster"
17+
}
18+
},
19+
"require": {
20+
"php": "^8.1",
21+
"google/gax": "^1.40.0"
22+
},
23+
"require-dev": {
24+
"phpunit/phpunit": "^9.0"
25+
},
26+
"suggest": {
27+
"ext-grpc": "Enables use of gRPC, a universal high-performance RPC framework created by Google.",
28+
"ext-protobuf": "Provides a significant increase in throughput over the pure PHP protobuf implementation. See https://cloud.google.com/php/grpc for installation instructions."
29+
}
30+
}
12.9 KB
Binary file not shown.

0 commit comments

Comments
 (0)