feat: Add OnPremCluster and MultiCloudCluster as GkeCluster equ…

…ivalent field (#108) - [ ] Regenerate this pull request now. feat: Move `GkeCluster` under oneof PiperOrigin-RevId: 393865355 Source-Link: googleapis/googleapis@fbae10c Source-Link: googleapis/googleapis-gen@cdd72be
googleapis · Sep 8, 2021 · b9e9611 · b9e9611
1 parent 3d599d8
commit b9e9611
Show file tree

Hide file tree

Showing 26 changed files with 8,858 additions and 250 deletions.
diff --git a/google-cloud-gkehub/src/main/java/com/google/cloud/gkehub/v1alpha2/GkeHubClient.java b/google-cloud-gkehub/src/main/java/com/google/cloud/gkehub/v1alpha2/GkeHubClient.java
@@ -41,8 +41,15 @@
 
 // AUTO-GENERATED DOCUMENTATION AND CLASS.
 /**
- * Service Description: GKE Hub CRUD API for the Membership resource. The Membership service is
- * currently only available in the global location.
+ * Service Description: The GKE Hub service handles the registration of many Kubernetes clusters to
+ * Google Cloud, represented with the [Membership][google.cloud.gkehub.v1alpha2.Membership]
+ * resource.
+ *
+ * <p>GKE Hub is currently only available in the global region.
+ *
+ * <p>&#42;&#42;Membership management may be non-trivial:&#42;&#42; it is recommended to use one of
+ * the Google-provided client libraries or tools where possible when working with Membership
+ * resources.
  *
  * <p>This class provides the ability to make remote calls to the backing service through method
  * calls that map to API methods. Sample code to get started:
@@ -400,7 +407,11 @@ public final UnaryCallable<GetMembershipRequest, Membership> getMembershipCallab
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
-   * Adds a new Membership.
+   * Creates a new Membership.
+   *
+   * <p>&#42;&#42;This is currently only supported for GKE clusters on Google Cloud&#42;&#42;. To
+   * register other clusters, follow the instructions at
+   * https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
    *
    * <p>Sample code:
    *
@@ -438,7 +449,11 @@ public final OperationFuture<Membership, OperationMetadata> createMembershipAsyn
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
-   * Adds a new Membership.
+   * Creates a new Membership.
+   *
+   * <p>&#42;&#42;This is currently only supported for GKE clusters on Google Cloud&#42;&#42;. To
+   * register other clusters, follow the instructions at
+   * https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
    *
    * <p>Sample code:
    *
@@ -476,7 +491,11 @@ public final OperationFuture<Membership, OperationMetadata> createMembershipAsyn
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
-   * Adds a new Membership.
+   * Creates a new Membership.
+   *
+   * <p>&#42;&#42;This is currently only supported for GKE clusters on Google Cloud&#42;&#42;. To
+   * register other clusters, follow the instructions at
+   * https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
    *
    * <p>Sample code:
    *
@@ -502,7 +521,11 @@ public final OperationFuture<Membership, OperationMetadata> createMembershipAsyn
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
-   * Adds a new Membership.
+   * Creates a new Membership.
+   *
+   * <p>&#42;&#42;This is currently only supported for GKE clusters on Google Cloud&#42;&#42;. To
+   * register other clusters, follow the instructions at
+   * https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
    *
    * <p>Sample code:
    *
@@ -528,7 +551,11 @@ public final OperationFuture<Membership, OperationMetadata> createMembershipAsyn
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
-   * Adds a new Membership.
+   * Creates a new Membership.
+   *
+   * <p>&#42;&#42;This is currently only supported for GKE clusters on Google Cloud&#42;&#42;. To
+   * register other clusters, follow the instructions at
+   * https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
    *
    * <p>Sample code:
    *
@@ -554,6 +581,10 @@ public final UnaryCallable<CreateMembershipRequest, Operation> createMembershipC
   /**
    * Removes a Membership.
    *
+   * <p>&#42;&#42;This is currently only supported for GKE clusters on Google Cloud&#42;&#42;. To
+   * unregister other clusters, follow the instructions at
+   * https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -578,6 +609,10 @@ public final OperationFuture<Empty, OperationMetadata> deleteMembershipAsync(
   /**
    * Removes a Membership.
    *
+   * <p>&#42;&#42;This is currently only supported for GKE clusters on Google Cloud&#42;&#42;. To
+   * unregister other clusters, follow the instructions at
+   * https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -600,6 +635,10 @@ public final OperationFuture<Empty, OperationMetadata> deleteMembershipAsync(Str
   /**
    * Removes a Membership.
    *
+   * <p>&#42;&#42;This is currently only supported for GKE clusters on Google Cloud&#42;&#42;. To
+   * unregister other clusters, follow the instructions at
+   * https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -624,6 +663,10 @@ public final OperationFuture<Empty, OperationMetadata> deleteMembershipAsync(
   /**
    * Removes a Membership.
    *
+   * <p>&#42;&#42;This is currently only supported for GKE clusters on Google Cloud&#42;&#42;. To
+   * unregister other clusters, follow the instructions at
+   * https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -648,6 +691,10 @@ public final OperationFuture<Empty, OperationMetadata> deleteMembershipAsync(
   /**
    * Removes a Membership.
    *
+   * <p>&#42;&#42;This is currently only supported for GKE clusters on Google Cloud&#42;&#42;. To
+   * unregister other clusters, follow the instructions at
+   * https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -686,7 +733,9 @@ public final UnaryCallable<DeleteMembershipRequest, Operation> deleteMembershipC
    * @param resource Required. Only fields specified in update_mask are updated. If you specify a
    *     field in the update_mask but don't specify its value here that field will be deleted. If
    *     you are updating a map field, set the value of a key to null or empty string to delete the
-   *     key from the map. It's not possible to update a key's value to the empty string.
+   *     key from the map. It's not possible to update a key's value to the empty string. If you
+   *     specify the update_mask to be a special path "&#42;", fully replaces all user-modifiable
+   *     fields to match `resource`.
    * @param updateMask Required. Mask of fields to update.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
@@ -781,6 +830,9 @@ public final UnaryCallable<UpdateMembershipRequest, Operation> updateMembershipC
   /**
    * Generates the manifest for deployment of the GKE connect agent.
    *
+   * <p>&#42;&#42;This method is used internally by Google-provided libraries.&#42;&#42; Most
+   * clients should not need to call this method directly.
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -811,6 +863,9 @@ public final GenerateConnectManifestResponse generateConnectManifest(
   /**
    * Generates the manifest for deployment of the GKE connect agent.
    *
+   * <p>&#42;&#42;This method is used internally by Google-provided libraries.&#42;&#42; Most
+   * clients should not need to call this method directly.
+   *
    * <p>Sample code:
    *
    * <pre>{@code

diff --git a/google-cloud-gkehub/src/main/java/com/google/cloud/gkehub/v1alpha2/package-info.java b/google-cloud-gkehub/src/main/java/com/google/cloud/gkehub/v1alpha2/package-info.java
@@ -15,12 +15,21 @@
  */
 
 /**
- * The interfaces provided are listed below, along with usage samples.
+ * A client to GKE Hub API
+ *
+ * <p>The interfaces provided are listed below, along with usage samples.
  *
  * <p>======================= GkeHubClient =======================
  *
- * <p>Service Description: GKE Hub CRUD API for the Membership resource. The Membership service is
- * currently only available in the global location.
+ * <p>Service Description: The GKE Hub service handles the registration of many Kubernetes clusters
+ * to Google Cloud, represented with the [Membership][google.cloud.gkehub.v1alpha2.Membership]
+ * resource.
+ *
+ * <p>GKE Hub is currently only available in the global region.
+ *
+ * <p>&#42;&#42;Membership management may be non-trivial:&#42;&#42; it is recommended to use one of
+ * the Google-provided client libraries or tools where possible when working with Membership
+ * resources.
  *
  * <p>Sample for GkeHubClient:
  *

diff --git a/...ogle-cloud-gkehub-v1alpha2/src/main/java/com/google/cloud/gkehub/v1alpha2/GkeHubGrpc.java b/...ogle-cloud-gkehub-v1alpha2/src/main/java/com/google/cloud/gkehub/v1alpha2/GkeHubGrpc.java
@@ -21,8 +21,12 @@
  *
  *
  * <pre>
- * GKE Hub CRUD API for the Membership resource.
- * The Membership service is currently only available in the global location.
+ * The GKE Hub service handles the registration of many Kubernetes
+ * clusters to Google Cloud, represented with the [Membership][google.cloud.gkehub.v1alpha2.Membership] resource.
+ * GKE Hub is currently only available in the global region.
+ * **Membership management may be non-trivial:** it is recommended to use one
+ * of the Google-provided client libraries or tools where possible when working
+ * with Membership resources.
  * </pre>
  */
 @javax.annotation.Generated(
@@ -400,8 +404,12 @@ public GkeHubFutureStub newStub(
    *
    *
    * <pre>
-   * GKE Hub CRUD API for the Membership resource.
-   * The Membership service is currently only available in the global location.
+   * The GKE Hub service handles the registration of many Kubernetes
+   * clusters to Google Cloud, represented with the [Membership][google.cloud.gkehub.v1alpha2.Membership] resource.
+   * GKE Hub is currently only available in the global region.
+   * **Membership management may be non-trivial:** it is recommended to use one
+   * of the Google-provided client libraries or tools where possible when working
+   * with Membership resources.
    * </pre>
    */
   public abstract static class GkeHubImplBase implements io.grpc.BindableService {
@@ -439,7 +447,10 @@ public void getMembership(
      *
      *
      * <pre>
-     * Adds a new Membership.
+     * Creates a new Membership.
+     * **This is currently only supported for GKE clusters on Google Cloud**.
+     * To register other clusters, follow the instructions at
+     * https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
      * </pre>
      */
     public void createMembership(
@@ -454,6 +465,9 @@ public void createMembership(
      *
      * <pre>
      * Removes a Membership.
+     * **This is currently only supported for GKE clusters on Google Cloud**.
+     * To unregister other clusters, follow the instructions at
+     * https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
      * </pre>
      */
     public void deleteMembership(
@@ -482,6 +496,8 @@ public void updateMembership(
      *
      * <pre>
      * Generates the manifest for deployment of the GKE connect agent.
+     * **This method is used internally by Google-provided libraries.**
+     * Most clients should not need to call this method directly.
      * </pre>
      */
     public void generateConnectManifest(
@@ -570,8 +586,12 @@ public final io.grpc.ServerServiceDefinition bindService() {
    *
    *
    * <pre>
-   * GKE Hub CRUD API for the Membership resource.
-   * The Membership service is currently only available in the global location.
+   * The GKE Hub service handles the registration of many Kubernetes
+   * clusters to Google Cloud, represented with the [Membership][google.cloud.gkehub.v1alpha2.Membership] resource.
+   * GKE Hub is currently only available in the global region.
+   * **Membership management may be non-trivial:** it is recommended to use one
+   * of the Google-provided client libraries or tools where possible when working
+   * with Membership resources.
    * </pre>
    */
   public static final class GkeHubStub extends io.grpc.stub.AbstractAsyncStub<GkeHubStub> {
@@ -621,7 +641,10 @@ public void getMembership(
      *
      *
      * <pre>
-     * Adds a new Membership.
+     * Creates a new Membership.
+     * **This is currently only supported for GKE clusters on Google Cloud**.
+     * To register other clusters, follow the instructions at
+     * https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
      * </pre>
      */
     public void createMembership(
@@ -638,6 +661,9 @@ public void createMembership(
      *
      * <pre>
      * Removes a Membership.
+     * **This is currently only supported for GKE clusters on Google Cloud**.
+     * To unregister other clusters, follow the instructions at
+     * https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
      * </pre>
      */
     public void deleteMembership(
@@ -670,6 +696,8 @@ public void updateMembership(
      *
      * <pre>
      * Generates the manifest for deployment of the GKE connect agent.
+     * **This method is used internally by Google-provided libraries.**
+     * Most clients should not need to call this method directly.
      * </pre>
      */
     public void generateConnectManifest(
@@ -711,8 +739,12 @@ public void initializeHub(
    *
    *
    * <pre>
-   * GKE Hub CRUD API for the Membership resource.
-   * The Membership service is currently only available in the global location.
+   * The GKE Hub service handles the registration of many Kubernetes
+   * clusters to Google Cloud, represented with the [Membership][google.cloud.gkehub.v1alpha2.Membership] resource.
+   * GKE Hub is currently only available in the global region.
+   * **Membership management may be non-trivial:** it is recommended to use one
+   * of the Google-provided client libraries or tools where possible when working
+   * with Membership resources.
    * </pre>
    */
   public static final class GkeHubBlockingStub
@@ -756,7 +788,10 @@ public com.google.cloud.gkehub.v1alpha2.Membership getMembership(
      *
      *
      * <pre>
-     * Adds a new Membership.
+     * Creates a new Membership.
+     * **This is currently only supported for GKE clusters on Google Cloud**.
+     * To register other clusters, follow the instructions at
+     * https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
      * </pre>
      */
     public com.google.longrunning.Operation createMembership(
@@ -770,6 +805,9 @@ public com.google.longrunning.Operation createMembership(
      *
      * <pre>
      * Removes a Membership.
+     * **This is currently only supported for GKE clusters on Google Cloud**.
+     * To unregister other clusters, follow the instructions at
+     * https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
      * </pre>
      */
     public com.google.longrunning.Operation deleteMembership(
@@ -796,6 +834,8 @@ public com.google.longrunning.Operation updateMembership(
      *
      * <pre>
      * Generates the manifest for deployment of the GKE connect agent.
+     * **This method is used internally by Google-provided libraries.**
+     * Most clients should not need to call this method directly.
      * </pre>
      */
     public com.google.cloud.gkehub.v1alpha2.GenerateConnectManifestResponse generateConnectManifest(
@@ -828,8 +868,12 @@ public com.google.cloud.gkehub.v1alpha2.InitializeHubResponse initializeHub(
    *
    *
    * <pre>
-   * GKE Hub CRUD API for the Membership resource.
-   * The Membership service is currently only available in the global location.
+   * The GKE Hub service handles the registration of many Kubernetes
+   * clusters to Google Cloud, represented with the [Membership][google.cloud.gkehub.v1alpha2.Membership] resource.
+   * GKE Hub is currently only available in the global region.
+   * **Membership management may be non-trivial:** it is recommended to use one
+   * of the Google-provided client libraries or tools where possible when working
+   * with Membership resources.
    * </pre>
    */
   public static final class GkeHubFutureStub
@@ -875,7 +919,10 @@ protected GkeHubFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions ca
      *
      *
      * <pre>
-     * Adds a new Membership.
+     * Creates a new Membership.
+     * **This is currently only supported for GKE clusters on Google Cloud**.
+     * To register other clusters, follow the instructions at
+     * https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
      * </pre>
      */
     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
      *
      * <pre>
      * Removes a Membership.
+     * **This is currently only supported for GKE clusters on Google Cloud**.
+     * To unregister other clusters, follow the instructions at
+     * https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
      * </pre>
      */
     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
      *
      * <pre>
      * Generates the manifest for deployment of the GKE connect agent.
+     * **This method is used internally by Google-provided libraries.**
+     * Most clients should not need to call this method directly.
      * </pre>
      */
     public com.google.common.util.concurrent.ListenableFuture<