Package com.google.cloud.gkehub.v1beta1

Class GkeHubMembershipServiceClient

java.lang.Object
com.google.cloud.gkehub.v1beta1.GkeHubMembershipServiceClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@BetaApi @Generated("by gapic-generator-java") public class GkeHubMembershipServiceClient extends Object implements BackgroundResource
Service Description: The GKE Hub MembershipService handles the registration of many Kubernetes clusters to Google Cloud, represented with the [Membership][google.cloud.gkehub.v1beta1.Membership] resource.

GKE Hub is currently available in the global region and all regions in https://cloud.google.com/compute/docs/regions-zones.

**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.

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: 


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   MembershipName name = MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]");
   Membership response = gkeHubMembershipServiceClient.getMembership(name);
 }

Note: close() needs to be called on the GkeHubMembershipServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

ListMemberships

Lists Memberships in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listMemberships(ListMembershipsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listMemberships(LocationName parent)

  • listMemberships(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listMembershipsPagedCallable()

  • listMembershipsCallable()

GetMembership

Gets the details of a Membership.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getMembership(GetMembershipRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getMembership(MembershipName name)

  • getMembership(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getMembershipCallable()

CreateMembership

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createMembershipAsync(CreateMembershipRequest request)

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

  • createMembershipAsync(LocationName parent, Membership resource, String membershipId)

  • createMembershipAsync(String parent, Membership resource, String membershipId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createMembershipOperationCallable()

  • createMembershipCallable()

DeleteMembership

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteMembershipAsync(DeleteMembershipRequest request)

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

  • deleteMembershipAsync(MembershipName name)

  • deleteMembershipAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteMembershipOperationCallable()

  • deleteMembershipCallable()

UpdateMembership

Updates an existing Membership.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateMembershipAsync(UpdateMembershipRequest request)

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

  • updateMembershipAsync(MembershipName name, Membership resource, FieldMask updateMask)

  • updateMembershipAsync(String name, Membership resource, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateMembershipOperationCallable()

  • updateMembershipCallable()

GenerateConnectManifest

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • generateConnectManifest(GenerateConnectManifestRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • generateConnectManifestCallable()

ValidateExclusivity

ValidateExclusivity validates the state of exclusivity in the cluster. The validation does not depend on an existing Hub membership resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • validateExclusivity(ValidateExclusivityRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • validateExclusivityCallable()

GenerateExclusivityManifest

GenerateExclusivityManifest generates the manifests to update the exclusivity artifacts in the cluster if needed.

Exclusivity artifacts include the Membership custom resource definition (CRD) and the singleton Membership custom resource (CR). Combined with ValidateExclusivity, exclusivity artifacts guarantee that a Kubernetes cluster is only registered to a single GKE Hub.

The Membership CRD is versioned, and may require conversion when the GKE Hub API server begins serving a newer version of the CRD and corresponding CR. The response will be the converted CRD and CR if there are any differences between the versions.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • generateExclusivityManifest(GenerateExclusivityManifestRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • generateExclusivityManifestCallable()

ListLocations

Lists information about the supported locations for this service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setIamPolicy(SetIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setIamPolicyCallable()

GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getIamPolicy(GetIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getIamPolicyCallable()

TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • testIamPermissions(TestIamPermissionsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • testIamPermissionsCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of GkeHubMembershipServiceSettings to create(). For example:

To customize credentials: 


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 GkeHubMembershipServiceSettings gkeHubMembershipServiceSettings =
     GkeHubMembershipServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create(gkeHubMembershipServiceSettings);

To customize the endpoint: 


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 GkeHubMembershipServiceSettings gkeHubMembershipServiceSettings =
     GkeHubMembershipServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create(gkeHubMembershipServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire: 


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 GkeHubMembershipServiceSettings gkeHubMembershipServiceSettings =
     GkeHubMembershipServiceSettings.newHttpJsonBuilder().build();
 GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create(gkeHubMembershipServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

  • Constructor Details

    • GkeHubMembershipServiceClient

      protected GkeHubMembershipServiceClient(GkeHubMembershipServiceSettings settings) throws IOException
      Constructs an instance of GkeHubMembershipServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
      Throws:
      IOException

    • GkeHubMembershipServiceClient

      protected GkeHubMembershipServiceClient(GkeHubMembershipServiceStub stub)

  • Method Details

    • create

      public static final GkeHubMembershipServiceClient create() throws IOException
      Constructs an instance of GkeHubMembershipServiceClient with default settings.
      Throws:
      IOException

    • create

      public static final GkeHubMembershipServiceClient create(GkeHubMembershipServiceSettings settings) throws IOException
      Constructs an instance of GkeHubMembershipServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
      Throws:
      IOException

    • create

      public static final GkeHubMembershipServiceClient create(GkeHubMembershipServiceStub stub)
      Constructs an instance of GkeHubMembershipServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(GkeHubMembershipServiceSettings).

    • getSettings

      public final GkeHubMembershipServiceSettings getSettings()

    • getStub

      public GkeHubMembershipServiceStub getStub()

    • getOperationsClient

      public final OperationsClient getOperationsClient()
      Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

    • getHttpJsonOperationsClient

      @BetaApi public final OperationsClient getHttpJsonOperationsClient()
      Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

    • listMemberships

      public final GkeHubMembershipServiceClient.ListMembershipsPagedResponse listMemberships(LocationName parent)
      Lists Memberships in a given project and location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Membership element :
       gkeHubMembershipServiceClient.listMemberships(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent (project and location) where the Memberships will be listed. Specified in the format `projects/*/locations/*`. `projects/*/locations/-` list memberships in all the regions.
      Throws:
      ApiException - if the remote call fails

    • listMemberships

      public final GkeHubMembershipServiceClient.ListMembershipsPagedResponse listMemberships(String parent)
      Lists Memberships in a given project and location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Membership element :
       gkeHubMembershipServiceClient.listMemberships(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent (project and location) where the Memberships will be listed. Specified in the format `projects/*/locations/*`. `projects/*/locations/-` list memberships in all the regions.
      Throws:
      ApiException - if the remote call fails

    • listMemberships

      public final GkeHubMembershipServiceClient.ListMembershipsPagedResponse listMemberships(ListMembershipsRequest request)
      Lists Memberships in a given project and location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   ListMembershipsRequest request =
       ListMembershipsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Membership element :
       gkeHubMembershipServiceClient.listMemberships(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listMembershipsPagedCallable

      public final UnaryCallable<ListMembershipsRequest,GkeHubMembershipServiceClient.ListMembershipsPagedResponse> listMembershipsPagedCallable()
      Lists Memberships in a given project and location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   ListMembershipsRequest request =
       ListMembershipsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Membership> future =
       gkeHubMembershipServiceClient.listMembershipsPagedCallable().futureCall(request);
   // Do something.
   for (Membership element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listMembershipsCallable

      public final UnaryCallable<ListMembershipsRequest,ListMembershipsResponse> listMembershipsCallable()
      Lists Memberships in a given project and location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   ListMembershipsRequest request =
       ListMembershipsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListMembershipsResponse response =
         gkeHubMembershipServiceClient.listMembershipsCallable().call(request);
     for (Membership element : response.getResourcesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • getMembership

      public final Membership getMembership(MembershipName name)
      Gets the details of a Membership.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   MembershipName name = MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]");
   Membership response = gkeHubMembershipServiceClient.getMembership(name);
 }
      Parameters:
      name - Required. The Membership resource name in the format `projects/*/locations/*/memberships/*`.
      Throws:
      ApiException - if the remote call fails

    • getMembership

      public final Membership getMembership(String name)
      Gets the details of a Membership.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   String name = MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]").toString();
   Membership response = gkeHubMembershipServiceClient.getMembership(name);
 }
      Parameters:
      name - Required. The Membership resource name in the format `projects/*/locations/*/memberships/*`.
      Throws:
      ApiException - if the remote call fails

    • getMembership

      public final Membership getMembership(GetMembershipRequest request)
      Gets the details of a Membership.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   GetMembershipRequest request =
       GetMembershipRequest.newBuilder()
           .setName(MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]").toString())
           .build();
   Membership response = gkeHubMembershipServiceClient.getMembership(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getMembershipCallable

      public final UnaryCallable<GetMembershipRequest,Membership> getMembershipCallable()
      Gets the details of a Membership.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   GetMembershipRequest request =
       GetMembershipRequest.newBuilder()
           .setName(MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]").toString())
           .build();
   ApiFuture<Membership> future =
       gkeHubMembershipServiceClient.getMembershipCallable().futureCall(request);
   // Do something.
   Membership response = future.get();
 }

    • createMembershipAsync

      public final OperationFuture<Membership,OperationMetadata> createMembershipAsync(LocationName parent, Membership resource, String membershipId)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Membership resource = Membership.newBuilder().build();
   String membershipId = "membershipId517665681";
   Membership response =
       gkeHubMembershipServiceClient.createMembershipAsync(parent, resource, membershipId).get();
 }
      Parameters:
      parent - Required. The parent (project and location) where the Memberships will be created. Specified in the format `projects/*/locations/*`.
      resource - Required. The membership to create.
      membershipId - Required. Client chosen ID for the membership. `membership_id` must be a valid RFC 1123 compliant DNS label:

      1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character

      Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.

      Throws:
      ApiException - if the remote call fails

    • createMembershipAsync

      public final OperationFuture<Membership,OperationMetadata> createMembershipAsync(String parent, Membership resource, String membershipId)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Membership resource = Membership.newBuilder().build();
   String membershipId = "membershipId517665681";
   Membership response =
       gkeHubMembershipServiceClient.createMembershipAsync(parent, resource, membershipId).get();
 }
      Parameters:
      parent - Required. The parent (project and location) where the Memberships will be created. Specified in the format `projects/*/locations/*`.
      resource - Required. The membership to create.
      membershipId - Required. Client chosen ID for the membership. `membership_id` must be a valid RFC 1123 compliant DNS label:

      1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character

      Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.

      Throws:
      ApiException - if the remote call fails

    • createMembershipAsync

      public final OperationFuture<Membership,OperationMetadata> createMembershipAsync(CreateMembershipRequest request)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   CreateMembershipRequest request =
       CreateMembershipRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setMembershipId("membershipId517665681")
           .setResource(Membership.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Membership response = gkeHubMembershipServiceClient.createMembershipAsync(request).get();
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • createMembershipOperationCallable

      public final OperationCallable<CreateMembershipRequest,Membership,OperationMetadata> createMembershipOperationCallable()
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   CreateMembershipRequest request =
       CreateMembershipRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setMembershipId("membershipId517665681")
           .setResource(Membership.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Membership, OperationMetadata> future =
       gkeHubMembershipServiceClient.createMembershipOperationCallable().futureCall(request);
   // Do something.
   Membership response = future.get();
 }

    • createMembershipCallable

      public final UnaryCallable<CreateMembershipRequest,Operation> createMembershipCallable()
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   CreateMembershipRequest request =
       CreateMembershipRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setMembershipId("membershipId517665681")
           .setResource(Membership.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       gkeHubMembershipServiceClient.createMembershipCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

    • deleteMembershipAsync

      public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteMembershipAsync(MembershipName name)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   MembershipName name = MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]");
   gkeHubMembershipServiceClient.deleteMembershipAsync(name).get();
 }
      Parameters:
      name - Required. The Membership resource name in the format `projects/*/locations/*/memberships/*`.
      Throws:
      ApiException - if the remote call fails

    • deleteMembershipAsync

      public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteMembershipAsync(String name)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   String name = MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]").toString();
   gkeHubMembershipServiceClient.deleteMembershipAsync(name).get();
 }
      Parameters:
      name - Required. The Membership resource name in the format `projects/*/locations/*/memberships/*`.
      Throws:
      ApiException - if the remote call fails

    • deleteMembershipAsync

      public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteMembershipAsync(DeleteMembershipRequest request)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   DeleteMembershipRequest request =
       DeleteMembershipRequest.newBuilder()
           .setName(MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]").toString())
           .setRequestId("requestId693933066")
           .setForce(true)
           .build();
   gkeHubMembershipServiceClient.deleteMembershipAsync(request).get();
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • deleteMembershipOperationCallable

      public final OperationCallable<DeleteMembershipRequest,com.google.protobuf.Empty,OperationMetadata> deleteMembershipOperationCallable()
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   DeleteMembershipRequest request =
       DeleteMembershipRequest.newBuilder()
           .setName(MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]").toString())
           .setRequestId("requestId693933066")
           .setForce(true)
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       gkeHubMembershipServiceClient.deleteMembershipOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • deleteMembershipCallable

      public final UnaryCallable<DeleteMembershipRequest,Operation> deleteMembershipCallable()
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   DeleteMembershipRequest request =
       DeleteMembershipRequest.newBuilder()
           .setName(MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]").toString())
           .setRequestId("requestId693933066")
           .setForce(true)
           .build();
   ApiFuture<Operation> future =
       gkeHubMembershipServiceClient.deleteMembershipCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • updateMembershipAsync

      public final OperationFuture<Membership,OperationMetadata> updateMembershipAsync(MembershipName name, Membership resource, com.google.protobuf.FieldMask updateMask)
      Updates an existing Membership.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   MembershipName name = MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]");
   Membership resource = Membership.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Membership response =
       gkeHubMembershipServiceClient.updateMembershipAsync(name, resource, updateMask).get();
 }
      Parameters:
      name - Required. The membership resource name in the format: `projects/[project_id]/locations/global/memberships/[membership_id]`
      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. If you specify the update_mask to be a special path "*", fully replaces all user-modifiable fields to match `resource`.
      updateMask - Required. Mask of fields to update. At least one field path must be specified in this mask.
      Throws:
      ApiException - if the remote call fails

    • updateMembershipAsync

      public final OperationFuture<Membership,OperationMetadata> updateMembershipAsync(String name, Membership resource, com.google.protobuf.FieldMask updateMask)
      Updates an existing Membership.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   String name = MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]").toString();
   Membership resource = Membership.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Membership response =
       gkeHubMembershipServiceClient.updateMembershipAsync(name, resource, updateMask).get();
 }
      Parameters:
      name - Required. The membership resource name in the format: `projects/[project_id]/locations/global/memberships/[membership_id]`
      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. If you specify the update_mask to be a special path "*", fully replaces all user-modifiable fields to match `resource`.
      updateMask - Required. Mask of fields to update. At least one field path must be specified in this mask.
      Throws:
      ApiException - if the remote call fails

    • updateMembershipAsync

      public final OperationFuture<Membership,OperationMetadata> updateMembershipAsync(UpdateMembershipRequest request)
      Updates an existing Membership.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   UpdateMembershipRequest request =
       UpdateMembershipRequest.newBuilder()
           .setName(MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]").toString())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setResource(Membership.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Membership response = gkeHubMembershipServiceClient.updateMembershipAsync(request).get();
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • updateMembershipOperationCallable

      public final OperationCallable<UpdateMembershipRequest,Membership,OperationMetadata> updateMembershipOperationCallable()
      Updates an existing Membership.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   UpdateMembershipRequest request =
       UpdateMembershipRequest.newBuilder()
           .setName(MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]").toString())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setResource(Membership.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Membership, OperationMetadata> future =
       gkeHubMembershipServiceClient.updateMembershipOperationCallable().futureCall(request);
   // Do something.
   Membership response = future.get();
 }

    • updateMembershipCallable

      public final UnaryCallable<UpdateMembershipRequest,Operation> updateMembershipCallable()
      Updates an existing Membership.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   UpdateMembershipRequest request =
       UpdateMembershipRequest.newBuilder()
           .setName(MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]").toString())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setResource(Membership.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       gkeHubMembershipServiceClient.updateMembershipCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

    • generateConnectManifest

      public final GenerateConnectManifestResponse generateConnectManifest(GenerateConnectManifestRequest request)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   GenerateConnectManifestRequest request =
       GenerateConnectManifestRequest.newBuilder()
           .setName(MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]").toString())
           .setConnectAgent(ConnectAgent.newBuilder().build())
           .setVersion("version351608024")
           .setIsUpgrade(true)
           .setRegistry("registry-690212803")
           .setImagePullSecretContent(ByteString.EMPTY)
           .build();
   GenerateConnectManifestResponse response =
       gkeHubMembershipServiceClient.generateConnectManifest(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • generateConnectManifestCallable

      public final UnaryCallable<GenerateConnectManifestRequest,GenerateConnectManifestResponse> generateConnectManifestCallable()
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   GenerateConnectManifestRequest request =
       GenerateConnectManifestRequest.newBuilder()
           .setName(MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]").toString())
           .setConnectAgent(ConnectAgent.newBuilder().build())
           .setVersion("version351608024")
           .setIsUpgrade(true)
           .setRegistry("registry-690212803")
           .setImagePullSecretContent(ByteString.EMPTY)
           .build();
   ApiFuture<GenerateConnectManifestResponse> future =
       gkeHubMembershipServiceClient.generateConnectManifestCallable().futureCall(request);
   // Do something.
   GenerateConnectManifestResponse response = future.get();
 }

    • validateExclusivity

      public final ValidateExclusivityResponse validateExclusivity(ValidateExclusivityRequest request)
      ValidateExclusivity validates the state of exclusivity in the cluster. The validation does not depend on an existing Hub membership resource.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   ValidateExclusivityRequest request =
       ValidateExclusivityRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setCrManifest("crManifest-1971077186")
           .setIntendedMembership("intendedMembership-2074920351")
           .build();
   ValidateExclusivityResponse response =
       gkeHubMembershipServiceClient.validateExclusivity(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • validateExclusivityCallable

      public final UnaryCallable<ValidateExclusivityRequest,ValidateExclusivityResponse> validateExclusivityCallable()
      ValidateExclusivity validates the state of exclusivity in the cluster. The validation does not depend on an existing Hub membership resource.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   ValidateExclusivityRequest request =
       ValidateExclusivityRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setCrManifest("crManifest-1971077186")
           .setIntendedMembership("intendedMembership-2074920351")
           .build();
   ApiFuture<ValidateExclusivityResponse> future =
       gkeHubMembershipServiceClient.validateExclusivityCallable().futureCall(request);
   // Do something.
   ValidateExclusivityResponse response = future.get();
 }

    • generateExclusivityManifest

      public final GenerateExclusivityManifestResponse generateExclusivityManifest(GenerateExclusivityManifestRequest request)
      GenerateExclusivityManifest generates the manifests to update the exclusivity artifacts in the cluster if needed.

      Exclusivity artifacts include the Membership custom resource definition (CRD) and the singleton Membership custom resource (CR). Combined with ValidateExclusivity, exclusivity artifacts guarantee that a Kubernetes cluster is only registered to a single GKE Hub.

      The Membership CRD is versioned, and may require conversion when the GKE Hub API server begins serving a newer version of the CRD and corresponding CR. The response will be the converted CRD and CR if there are any differences between the versions.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   GenerateExclusivityManifestRequest request =
       GenerateExclusivityManifestRequest.newBuilder()
           .setName(MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]").toString())
           .setCrdManifest("crdManifest1401188132")
           .setCrManifest("crManifest-1971077186")
           .build();
   GenerateExclusivityManifestResponse response =
       gkeHubMembershipServiceClient.generateExclusivityManifest(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • generateExclusivityManifestCallable

      public final UnaryCallable<GenerateExclusivityManifestRequest,GenerateExclusivityManifestResponse> generateExclusivityManifestCallable()
      GenerateExclusivityManifest generates the manifests to update the exclusivity artifacts in the cluster if needed.

      Exclusivity artifacts include the Membership custom resource definition (CRD) and the singleton Membership custom resource (CR). Combined with ValidateExclusivity, exclusivity artifacts guarantee that a Kubernetes cluster is only registered to a single GKE Hub.

      The Membership CRD is versioned, and may require conversion when the GKE Hub API server begins serving a newer version of the CRD and corresponding CR. The response will be the converted CRD and CR if there are any differences between the versions.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   GenerateExclusivityManifestRequest request =
       GenerateExclusivityManifestRequest.newBuilder()
           .setName(MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]").toString())
           .setCrdManifest("crdManifest1401188132")
           .setCrManifest("crManifest-1971077186")
           .build();
   ApiFuture<GenerateExclusivityManifestResponse> future =
       gkeHubMembershipServiceClient.generateExclusivityManifestCallable().futureCall(request);
   // Do something.
   GenerateExclusivityManifestResponse response = future.get();
 }

    • listLocations

      public final GkeHubMembershipServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)
      Lists information about the supported locations for this service.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : gkeHubMembershipServiceClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listLocationsPagedCallable

      public final UnaryCallable<ListLocationsRequest,GkeHubMembershipServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()
      Lists information about the supported locations for this service.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       gkeHubMembershipServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listLocationsCallable

      public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()
      Lists information about the supported locations for this service.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         gkeHubMembershipServiceClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • getLocation

      public final Location getLocation(GetLocationRequest request)
      Gets information about a location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = gkeHubMembershipServiceClient.getLocation(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getLocationCallable

      public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()
      Gets information about a location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       gkeHubMembershipServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }

    • setIamPolicy

      public final Policy setIamPolicy(SetIamPolicyRequest request)
      Sets the access control policy on the specified resource. Replacesany existing policy.

      Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = gkeHubMembershipServiceClient.setIamPolicy(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • setIamPolicyCallable

      public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()
      Sets the access control policy on the specified resource. Replacesany existing policy.

      Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       gkeHubMembershipServiceClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

    • getIamPolicy

      public final Policy getIamPolicy(GetIamPolicyRequest request)
      Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = gkeHubMembershipServiceClient.getIamPolicy(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getIamPolicyCallable

      public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()
      Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       gkeHubMembershipServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

    • testIamPermissions

      public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)
      Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.

      Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response =
       gkeHubMembershipServiceClient.testIamPermissions(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • testIamPermissionsCallable

      public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()
      Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.

      Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
     GkeHubMembershipServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       gkeHubMembershipServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }

    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable

    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface BackgroundResource

    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface BackgroundResource

    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface BackgroundResource

    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface BackgroundResource

    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface BackgroundResource
      Throws:
      InterruptedException