Skip to content
This repository was archived by the owner on Jul 17, 2023. It is now read-only.

Commit b9e9611

Browse files
feat: Add OnPremCluster and MultiCloudCluster as GkeCluster equivalent field (#108)
- [ ] Regenerate this pull request now. feat: Move `GkeCluster` under oneof PiperOrigin-RevId: 393865355 Source-Link: googleapis/googleapis@fbae10c Source-Link: https://github.com/googleapis/googleapis-gen/commit/cdd72be20399367f7f86df2ce3dec3afa2bc8f64
1 parent 3d599d8 commit b9e9611

26 files changed

Lines changed: 8858 additions & 250 deletions

google-cloud-gkehub/src/main/java/com/google/cloud/gkehub/v1alpha2/GkeHubClient.java

Lines changed: 63 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,15 @@
4141

4242
// AUTO-GENERATED DOCUMENTATION AND CLASS.
4343
/**
44-
* Service Description: GKE Hub CRUD API for the Membership resource. The Membership service is
45-
* currently only available in the global location.
44+
* Service Description: The GKE Hub service handles the registration of many Kubernetes clusters to
45+
* Google Cloud, represented with the [Membership][google.cloud.gkehub.v1alpha2.Membership]
46+
* resource.
47+
*
48+
* <p>GKE Hub is currently only available in the global region.
49+
*
50+
* <p>&#42;&#42;Membership management may be non-trivial:&#42;&#42; it is recommended to use one of
51+
* the Google-provided client libraries or tools where possible when working with Membership
52+
* resources.
4653
*
4754
* <p>This class provides the ability to make remote calls to the backing service through method
4855
* calls that map to API methods. Sample code to get started:
@@ -400,7 +407,11 @@ public final UnaryCallable<GetMembershipRequest, Membership> getMembershipCallab
400407

401408
// AUTO-GENERATED DOCUMENTATION AND METHOD.
402409
/**
403-
* Adds a new Membership.
410+
* Creates a new Membership.
411+
*
412+
* <p>&#42;&#42;This is currently only supported for GKE clusters on Google Cloud&#42;&#42;. To
413+
* register other clusters, follow the instructions at
414+
* https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
404415
*
405416
* <p>Sample code:
406417
*
@@ -438,7 +449,11 @@ public final OperationFuture<Membership, OperationMetadata> createMembershipAsyn
438449

439450
// AUTO-GENERATED DOCUMENTATION AND METHOD.
440451
/**
441-
* Adds a new Membership.
452+
* Creates a new Membership.
453+
*
454+
* <p>&#42;&#42;This is currently only supported for GKE clusters on Google Cloud&#42;&#42;. To
455+
* register other clusters, follow the instructions at
456+
* https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
442457
*
443458
* <p>Sample code:
444459
*
@@ -476,7 +491,11 @@ public final OperationFuture<Membership, OperationMetadata> createMembershipAsyn
476491

477492
// AUTO-GENERATED DOCUMENTATION AND METHOD.
478493
/**
479-
* Adds a new Membership.
494+
* Creates a new Membership.
495+
*
496+
* <p>&#42;&#42;This is currently only supported for GKE clusters on Google Cloud&#42;&#42;. To
497+
* register other clusters, follow the instructions at
498+
* https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
480499
*
481500
* <p>Sample code:
482501
*
@@ -502,7 +521,11 @@ public final OperationFuture<Membership, OperationMetadata> createMembershipAsyn
502521

503522
// AUTO-GENERATED DOCUMENTATION AND METHOD.
504523
/**
505-
* Adds a new Membership.
524+
* Creates a new Membership.
525+
*
526+
* <p>&#42;&#42;This is currently only supported for GKE clusters on Google Cloud&#42;&#42;. To
527+
* register other clusters, follow the instructions at
528+
* https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
506529
*
507530
* <p>Sample code:
508531
*
@@ -528,7 +551,11 @@ public final OperationFuture<Membership, OperationMetadata> createMembershipAsyn
528551

529552
// AUTO-GENERATED DOCUMENTATION AND METHOD.
530553
/**
531-
* Adds a new Membership.
554+
* Creates a new Membership.
555+
*
556+
* <p>&#42;&#42;This is currently only supported for GKE clusters on Google Cloud&#42;&#42;. To
557+
* register other clusters, follow the instructions at
558+
* https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
532559
*
533560
* <p>Sample code:
534561
*
@@ -554,6 +581,10 @@ public final UnaryCallable<CreateMembershipRequest, Operation> createMembershipC
554581
/**
555582
* Removes a Membership.
556583
*
584+
* <p>&#42;&#42;This is currently only supported for GKE clusters on Google Cloud&#42;&#42;. To
585+
* unregister other clusters, follow the instructions at
586+
* https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
587+
*
557588
* <p>Sample code:
558589
*
559590
* <pre>{@code
@@ -578,6 +609,10 @@ public final OperationFuture<Empty, OperationMetadata> deleteMembershipAsync(
578609
/**
579610
* Removes a Membership.
580611
*
612+
* <p>&#42;&#42;This is currently only supported for GKE clusters on Google Cloud&#42;&#42;. To
613+
* unregister other clusters, follow the instructions at
614+
* https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
615+
*
581616
* <p>Sample code:
582617
*
583618
* <pre>{@code
@@ -600,6 +635,10 @@ public final OperationFuture<Empty, OperationMetadata> deleteMembershipAsync(Str
600635
/**
601636
* Removes a Membership.
602637
*
638+
* <p>&#42;&#42;This is currently only supported for GKE clusters on Google Cloud&#42;&#42;. To
639+
* unregister other clusters, follow the instructions at
640+
* https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
641+
*
603642
* <p>Sample code:
604643
*
605644
* <pre>{@code
@@ -624,6 +663,10 @@ public final OperationFuture<Empty, OperationMetadata> deleteMembershipAsync(
624663
/**
625664
* Removes a Membership.
626665
*
666+
* <p>&#42;&#42;This is currently only supported for GKE clusters on Google Cloud&#42;&#42;. To
667+
* unregister other clusters, follow the instructions at
668+
* https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
669+
*
627670
* <p>Sample code:
628671
*
629672
* <pre>{@code
@@ -648,6 +691,10 @@ public final OperationFuture<Empty, OperationMetadata> deleteMembershipAsync(
648691
/**
649692
* Removes a Membership.
650693
*
694+
* <p>&#42;&#42;This is currently only supported for GKE clusters on Google Cloud&#42;&#42;. To
695+
* unregister other clusters, follow the instructions at
696+
* https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
697+
*
651698
* <p>Sample code:
652699
*
653700
* <pre>{@code
@@ -686,7 +733,9 @@ public final UnaryCallable<DeleteMembershipRequest, Operation> deleteMembershipC
686733
* @param resource Required. Only fields specified in update_mask are updated. If you specify a
687734
* field in the update_mask but don't specify its value here that field will be deleted. If
688735
* you are updating a map field, set the value of a key to null or empty string to delete the
689-
* key from the map. It's not possible to update a key's value to the empty string.
736+
* key from the map. It's not possible to update a key's value to the empty string. If you
737+
* specify the update_mask to be a special path "&#42;", fully replaces all user-modifiable
738+
* fields to match `resource`.
690739
* @param updateMask Required. Mask of fields to update.
691740
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
692741
*/
@@ -781,6 +830,9 @@ public final UnaryCallable<UpdateMembershipRequest, Operation> updateMembershipC
781830
/**
782831
* Generates the manifest for deployment of the GKE connect agent.
783832
*
833+
* <p>&#42;&#42;This method is used internally by Google-provided libraries.&#42;&#42; Most
834+
* clients should not need to call this method directly.
835+
*
784836
* <p>Sample code:
785837
*
786838
* <pre>{@code
@@ -811,6 +863,9 @@ public final GenerateConnectManifestResponse generateConnectManifest(
811863
/**
812864
* Generates the manifest for deployment of the GKE connect agent.
813865
*
866+
* <p>&#42;&#42;This method is used internally by Google-provided libraries.&#42;&#42; Most
867+
* clients should not need to call this method directly.
868+
*
814869
* <p>Sample code:
815870
*
816871
* <pre>{@code

google-cloud-gkehub/src/main/java/com/google/cloud/gkehub/v1alpha2/package-info.java

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,21 @@
1515
*/
1616

1717
/**
18-
* The interfaces provided are listed below, along with usage samples.
18+
* A client to GKE Hub API
19+
*
20+
* <p>The interfaces provided are listed below, along with usage samples.
1921
*
2022
* <p>======================= GkeHubClient =======================
2123
*
22-
* <p>Service Description: GKE Hub CRUD API for the Membership resource. The Membership service is
23-
* currently only available in the global location.
24+
* <p>Service Description: The GKE Hub service handles the registration of many Kubernetes clusters
25+
* to Google Cloud, represented with the [Membership][google.cloud.gkehub.v1alpha2.Membership]
26+
* resource.
27+
*
28+
* <p>GKE Hub is currently only available in the global region.
29+
*
30+
* <p>&#42;&#42;Membership management may be non-trivial:&#42;&#42; it is recommended to use one of
31+
* the Google-provided client libraries or tools where possible when working with Membership
32+
* resources.
2433
*
2534
* <p>Sample for GkeHubClient:
2635
*

grpc-google-cloud-gkehub-v1alpha2/src/main/java/com/google/cloud/gkehub/v1alpha2/GkeHubGrpc.java

Lines changed: 66 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,12 @@
2121
*
2222
*
2323
* <pre>
24-
* GKE Hub CRUD API for the Membership resource.
25-
* The Membership service is currently only available in the global location.
24+
* The GKE Hub service handles the registration of many Kubernetes
25+
* clusters to Google Cloud, represented with the [Membership][google.cloud.gkehub.v1alpha2.Membership] resource.
26+
* GKE Hub is currently only available in the global region.
27+
* **Membership management may be non-trivial:** it is recommended to use one
28+
* of the Google-provided client libraries or tools where possible when working
29+
* with Membership resources.
2630
* </pre>
2731
*/
2832
@javax.annotation.Generated(
@@ -400,8 +404,12 @@ public GkeHubFutureStub newStub(
400404
*
401405
*
402406
* <pre>
403-
* GKE Hub CRUD API for the Membership resource.
404-
* The Membership service is currently only available in the global location.
407+
* The GKE Hub service handles the registration of many Kubernetes
408+
* clusters to Google Cloud, represented with the [Membership][google.cloud.gkehub.v1alpha2.Membership] resource.
409+
* GKE Hub is currently only available in the global region.
410+
* **Membership management may be non-trivial:** it is recommended to use one
411+
* of the Google-provided client libraries or tools where possible when working
412+
* with Membership resources.
405413
* </pre>
406414
*/
407415
public abstract static class GkeHubImplBase implements io.grpc.BindableService {
@@ -439,7 +447,10 @@ public void getMembership(
439447
*
440448
*
441449
* <pre>
442-
* Adds a new Membership.
450+
* Creates a new Membership.
451+
* **This is currently only supported for GKE clusters on Google Cloud**.
452+
* To register other clusters, follow the instructions at
453+
* https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
443454
* </pre>
444455
*/
445456
public void createMembership(
@@ -454,6 +465,9 @@ public void createMembership(
454465
*
455466
* <pre>
456467
* Removes a Membership.
468+
* **This is currently only supported for GKE clusters on Google Cloud**.
469+
* To unregister other clusters, follow the instructions at
470+
* https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
457471
* </pre>
458472
*/
459473
public void deleteMembership(
@@ -482,6 +496,8 @@ public void updateMembership(
482496
*
483497
* <pre>
484498
* Generates the manifest for deployment of the GKE connect agent.
499+
* **This method is used internally by Google-provided libraries.**
500+
* Most clients should not need to call this method directly.
485501
* </pre>
486502
*/
487503
public void generateConnectManifest(
@@ -570,8 +586,12 @@ public final io.grpc.ServerServiceDefinition bindService() {
570586
*
571587
*
572588
* <pre>
573-
* GKE Hub CRUD API for the Membership resource.
574-
* The Membership service is currently only available in the global location.
589+
* The GKE Hub service handles the registration of many Kubernetes
590+
* clusters to Google Cloud, represented with the [Membership][google.cloud.gkehub.v1alpha2.Membership] resource.
591+
* GKE Hub is currently only available in the global region.
592+
* **Membership management may be non-trivial:** it is recommended to use one
593+
* of the Google-provided client libraries or tools where possible when working
594+
* with Membership resources.
575595
* </pre>
576596
*/
577597
public static final class GkeHubStub extends io.grpc.stub.AbstractAsyncStub<GkeHubStub> {
@@ -621,7 +641,10 @@ public void getMembership(
621641
*
622642
*
623643
* <pre>
624-
* Adds a new Membership.
644+
* Creates a new Membership.
645+
* **This is currently only supported for GKE clusters on Google Cloud**.
646+
* To register other clusters, follow the instructions at
647+
* https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
625648
* </pre>
626649
*/
627650
public void createMembership(
@@ -638,6 +661,9 @@ public void createMembership(
638661
*
639662
* <pre>
640663
* Removes a Membership.
664+
* **This is currently only supported for GKE clusters on Google Cloud**.
665+
* To unregister other clusters, follow the instructions at
666+
* https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
641667
* </pre>
642668
*/
643669
public void deleteMembership(
@@ -670,6 +696,8 @@ public void updateMembership(
670696
*
671697
* <pre>
672698
* Generates the manifest for deployment of the GKE connect agent.
699+
* **This method is used internally by Google-provided libraries.**
700+
* Most clients should not need to call this method directly.
673701
* </pre>
674702
*/
675703
public void generateConnectManifest(
@@ -711,8 +739,12 @@ public void initializeHub(
711739
*
712740
*
713741
* <pre>
714-
* GKE Hub CRUD API for the Membership resource.
715-
* The Membership service is currently only available in the global location.
742+
* The GKE Hub service handles the registration of many Kubernetes
743+
* clusters to Google Cloud, represented with the [Membership][google.cloud.gkehub.v1alpha2.Membership] resource.
744+
* GKE Hub is currently only available in the global region.
745+
* **Membership management may be non-trivial:** it is recommended to use one
746+
* of the Google-provided client libraries or tools where possible when working
747+
* with Membership resources.
716748
* </pre>
717749
*/
718750
public static final class GkeHubBlockingStub
@@ -756,7 +788,10 @@ public com.google.cloud.gkehub.v1alpha2.Membership getMembership(
756788
*
757789
*
758790
* <pre>
759-
* Adds a new Membership.
791+
* Creates a new Membership.
792+
* **This is currently only supported for GKE clusters on Google Cloud**.
793+
* To register other clusters, follow the instructions at
794+
* https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
760795
* </pre>
761796
*/
762797
public com.google.longrunning.Operation createMembership(
@@ -770,6 +805,9 @@ public com.google.longrunning.Operation createMembership(
770805
*
771806
* <pre>
772807
* Removes a Membership.
808+
* **This is currently only supported for GKE clusters on Google Cloud**.
809+
* To unregister other clusters, follow the instructions at
810+
* https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
773811
* </pre>
774812
*/
775813
public com.google.longrunning.Operation deleteMembership(
@@ -796,6 +834,8 @@ public com.google.longrunning.Operation updateMembership(
796834
*
797835
* <pre>
798836
* Generates the manifest for deployment of the GKE connect agent.
837+
* **This method is used internally by Google-provided libraries.**
838+
* Most clients should not need to call this method directly.
799839
* </pre>
800840
*/
801841
public com.google.cloud.gkehub.v1alpha2.GenerateConnectManifestResponse generateConnectManifest(
@@ -828,8 +868,12 @@ public com.google.cloud.gkehub.v1alpha2.InitializeHubResponse initializeHub(
828868
*
829869
*
830870
* <pre>
831-
* GKE Hub CRUD API for the Membership resource.
832-
* The Membership service is currently only available in the global location.
871+
* The GKE Hub service handles the registration of many Kubernetes
872+
* clusters to Google Cloud, represented with the [Membership][google.cloud.gkehub.v1alpha2.Membership] resource.
873+
* GKE Hub is currently only available in the global region.
874+
* **Membership management may be non-trivial:** it is recommended to use one
875+
* of the Google-provided client libraries or tools where possible when working
876+
* with Membership resources.
833877
* </pre>
834878
*/
835879
public static final class GkeHubFutureStub
@@ -875,7 +919,10 @@ protected GkeHubFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions ca
875919
*
876920
*
877921
* <pre>
878-
* Adds a new Membership.
922+
* Creates a new Membership.
923+
* **This is currently only supported for GKE clusters on Google Cloud**.
924+
* To register other clusters, follow the instructions at
925+
* https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
879926
* </pre>
880927
*/
881928
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>
@@ -889,6 +936,9 @@ protected GkeHubFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions ca
889936
*
890937
* <pre>
891938
* Removes a Membership.
939+
* **This is currently only supported for GKE clusters on Google Cloud**.
940+
* To unregister other clusters, follow the instructions at
941+
* https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
892942
* </pre>
893943
*/
894944
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>
@@ -915,6 +965,8 @@ protected GkeHubFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions ca
915965
*
916966
* <pre>
917967
* Generates the manifest for deployment of the GKE connect agent.
968+
* **This method is used internally by Google-provided libraries.**
969+
* Most clients should not need to call this method directly.
918970
* </pre>
919971
*/
920972
public com.google.common.util.concurrent.ListenableFuture<

0 commit comments

Comments
 (0)