GkeHubMembershipServiceClient (Google GKE Hub API 1.6.0 API)

java.lang.Object
- com.google.cloud.gkehub.v1beta1.GkeHubMembershipServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class GkeHubMembershipServiceClient
extends Object
implements com.google.api.gax.core.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 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.

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().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GkeHubMembershipServiceClient.ListLocationsFixedSizeCollection`
`static class`	`GkeHubMembershipServiceClient.ListLocationsPage`
`static class`	`GkeHubMembershipServiceClient.ListLocationsPagedResponse`
`static class`	`GkeHubMembershipServiceClient.ListMembershipsFixedSizeCollection`
`static class`	`GkeHubMembershipServiceClient.ListMembershipsPage`
`static class`	`GkeHubMembershipServiceClient.ListMembershipsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`GkeHubMembershipServiceClient(GkeHubMembershipServiceSettings settings)` Constructs an instance of GkeHubMembershipServiceClient, using the given settings.
`protected`	`GkeHubMembershipServiceClient(GkeHubMembershipServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static GkeHubMembershipServiceClient`	`create()` Constructs an instance of GkeHubMembershipServiceClient with default settings.
`static GkeHubMembershipServiceClient`	`create(GkeHubMembershipServiceSettings settings)` Constructs an instance of GkeHubMembershipServiceClient, using the given settings.
`static GkeHubMembershipServiceClient`	`create(GkeHubMembershipServiceStub stub)` Constructs an instance of GkeHubMembershipServiceClient, using the given stub for making calls.
`com.google.api.gax.longrunning.OperationFuture<Membership,OperationMetadata>`	`createMembershipAsync(CreateMembershipRequest request)` Creates a new Membership.
`com.google.api.gax.longrunning.OperationFuture<Membership,OperationMetadata>`	`createMembershipAsync(LocationName parent, Membership resource, String membershipId)` Creates a new Membership.
`com.google.api.gax.longrunning.OperationFuture<Membership,OperationMetadata>`	`createMembershipAsync(String parent, Membership resource, String membershipId)` Creates a new Membership.
`com.google.api.gax.rpc.UnaryCallable<CreateMembershipRequest,com.google.longrunning.Operation>`	`createMembershipCallable()` Creates a new Membership.
`com.google.api.gax.rpc.OperationCallable<CreateMembershipRequest,Membership,OperationMetadata>`	`createMembershipOperationCallable()` Creates a new Membership.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>`	`deleteMembershipAsync(DeleteMembershipRequest request)` Removes a Membership.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>`	`deleteMembershipAsync(MembershipName name)` Removes a Membership.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>`	`deleteMembershipAsync(String name)` Removes a Membership.
`com.google.api.gax.rpc.UnaryCallable<DeleteMembershipRequest,com.google.longrunning.Operation>`	`deleteMembershipCallable()` Removes a Membership.
`com.google.api.gax.rpc.OperationCallable<DeleteMembershipRequest,com.google.protobuf.Empty,OperationMetadata>`	`deleteMembershipOperationCallable()` Removes a Membership.
`GenerateConnectManifestResponse`	`generateConnectManifest(GenerateConnectManifestRequest request)` Generates the manifest for deployment of the GKE connect agent.
`com.google.api.gax.rpc.UnaryCallable<GenerateConnectManifestRequest,GenerateConnectManifestResponse>`	`generateConnectManifestCallable()` Generates the manifest for deployment of the GKE connect agent.
`GenerateExclusivityManifestResponse`	`generateExclusivityManifest(GenerateExclusivityManifestRequest request)` GenerateExclusivityManifest generates the manifests to update the exclusivity artifacts in the cluster if needed.
`com.google.api.gax.rpc.UnaryCallable<GenerateExclusivityManifestRequest,GenerateExclusivityManifestResponse>`	`generateExclusivityManifestCallable()` GenerateExclusivityManifest generates the manifests to update the exclusivity artifacts in the cluster if needed.
`com.google.api.gax.httpjson.longrunning.OperationsClient`	`getHttpJsonOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`com.google.iam.v1.Policy`	`getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)` Gets the access control policy for a resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`	`getIamPolicyCallable()` Gets the access control policy for a resource.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`Membership`	`getMembership(GetMembershipRequest request)` Gets the details of a Membership.
`Membership`	`getMembership(MembershipName name)` Gets the details of a Membership.
`Membership`	`getMembership(String name)` Gets the details of a Membership.
`com.google.api.gax.rpc.UnaryCallable<GetMembershipRequest,Membership>`	`getMembershipCallable()` Gets the details of a Membership.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`GkeHubMembershipServiceSettings`	`getSettings()`
`GkeHubMembershipServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`GkeHubMembershipServiceClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,GkeHubMembershipServiceClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`GkeHubMembershipServiceClient.ListMembershipsPagedResponse`	`listMemberships(ListMembershipsRequest request)` Lists Memberships in a given project and location.
`GkeHubMembershipServiceClient.ListMembershipsPagedResponse`	`listMemberships(LocationName parent)` Lists Memberships in a given project and location.
`GkeHubMembershipServiceClient.ListMembershipsPagedResponse`	`listMemberships(String parent)` Lists Memberships in a given project and location.
`com.google.api.gax.rpc.UnaryCallable<ListMembershipsRequest,ListMembershipsResponse>`	`listMembershipsCallable()` Lists Memberships in a given project and location.
`com.google.api.gax.rpc.UnaryCallable<ListMembershipsRequest,GkeHubMembershipServiceClient.ListMembershipsPagedResponse>`	`listMembershipsPagedCallable()` Lists Memberships in a given project and location.
`com.google.iam.v1.Policy`	`setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)` Sets the access control policy on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`	`setIamPolicyCallable()` Sets the access control policy on the specified resource.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)` Returns permissions that a caller has on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`	`testIamPermissionsCallable()` Returns permissions that a caller has on the specified resource.
`com.google.api.gax.longrunning.OperationFuture<Membership,OperationMetadata>`	`updateMembershipAsync(MembershipName name, Membership resource, com.google.protobuf.FieldMask updateMask)` Updates an existing Membership.
`com.google.api.gax.longrunning.OperationFuture<Membership,OperationMetadata>`	`updateMembershipAsync(String name, Membership resource, com.google.protobuf.FieldMask updateMask)` Updates an existing Membership.
`com.google.api.gax.longrunning.OperationFuture<Membership,OperationMetadata>`	`updateMembershipAsync(UpdateMembershipRequest request)` Updates an existing Membership.
`com.google.api.gax.rpc.UnaryCallable<UpdateMembershipRequest,com.google.longrunning.Operation>`	`updateMembershipCallable()` Updates an existing Membership.
`com.google.api.gax.rpc.OperationCallable<UpdateMembershipRequest,Membership,OperationMetadata>`	`updateMembershipOperationCallable()` Updates an existing Membership.
`ValidateExclusivityResponse`	`validateExclusivity(ValidateExclusivityRequest request)` ValidateExclusivity validates the state of exclusivity in the cluster.
`com.google.api.gax.rpc.UnaryCallable<ValidateExclusivityRequest,ValidateExclusivityResponse>`	`validateExclusivityCallable()` ValidateExclusivity validates the state of exclusivity in the cluster.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- 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 Detail

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 com.google.longrunning.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 com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.