- 1.48.0 (latest)
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.6
- 1.2.1
- 1.1.0
- 1.0.1
- 0.5.4
public class GkeHubMembershipServiceClient implements BackgroundResource
Service Description: The GKE Hub MembershipService handles the registration of many Kubernetes clusters to Google Cloud, represented with the 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.
Implements
BackgroundResourceStatic Methods
create()
public static final GkeHubMembershipServiceClient create()
Constructs an instance of GkeHubMembershipServiceClient with default settings.
Type | Description |
GkeHubMembershipServiceClient |
Type | Description |
IOException |
create(GkeHubMembershipServiceSettings settings)
public static final GkeHubMembershipServiceClient create(GkeHubMembershipServiceSettings settings)
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.
Name | Description |
settings | GkeHubMembershipServiceSettings |
Type | Description |
GkeHubMembershipServiceClient |
Type | Description |
IOException |
create(GkeHubMembershipServiceStub stub)
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).
Name | Description |
stub | GkeHubMembershipServiceStub |
Type | Description |
GkeHubMembershipServiceClient |
Constructors
GkeHubMembershipServiceClient(GkeHubMembershipServiceSettings settings)
protected GkeHubMembershipServiceClient(GkeHubMembershipServiceSettings settings)
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.
Name | Description |
settings | GkeHubMembershipServiceSettings |
GkeHubMembershipServiceClient(GkeHubMembershipServiceStub stub)
protected GkeHubMembershipServiceClient(GkeHubMembershipServiceStub stub)
Name | Description |
stub | GkeHubMembershipServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
Type | Description |
InterruptedException |
close()
public final void close()
createMembershipAsync(CreateMembershipRequest request)
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();
}
Name | Description |
request | CreateMembershipRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Membership,OperationMetadata> |
createMembershipAsync(LocationName parent, Membership resource, String membershipId)
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();
}
Name | Description |
parent | LocationName Required. The parent (project and location) where the Memberships will be
created. Specified in the format |
resource | Membership Required. The membership to create. |
membershipId | String Required. Client chosen ID for the membership. 1. At most 63 characters in length 2. It must consist of lower case alphanumeric
characters or Which can be expressed as the regex: |
Type | Description |
OperationFuture<Membership,OperationMetadata> |
createMembershipAsync(String parent, Membership resource, String membershipId)
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();
}
Name | Description |
parent | String Required. The parent (project and location) where the Memberships will be
created. Specified in the format |
resource | Membership Required. The membership to create. |
membershipId | String Required. Client chosen ID for the membership. 1. At most 63 characters in length 2. It must consist of lower case alphanumeric
characters or Which can be expressed as the regex: |
Type | Description |
OperationFuture<Membership,OperationMetadata> |
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();
}
Type | Description |
UnaryCallable<CreateMembershipRequest,Operation> |
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();
}
Type | Description |
OperationCallable<CreateMembershipRequest,Membership,OperationMetadata> |
deleteMembershipAsync(DeleteMembershipRequest request)
public final OperationFuture<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")
.build();
gkeHubMembershipServiceClient.deleteMembershipAsync(request).get();
}
Name | Description |
request | DeleteMembershipRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteMembershipAsync(MembershipName name)
public final OperationFuture<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();
}
Name | Description |
name | MembershipName Required. The Membership resource name in the format
|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteMembershipAsync(String name)
public final OperationFuture<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();
}
Name | Description |
name | String Required. The Membership resource name in the format
|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
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")
.build();
ApiFuture<Operation> future =
gkeHubMembershipServiceClient.deleteMembershipCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
UnaryCallable<DeleteMembershipRequest,Operation> |
deleteMembershipOperationCallable()
public final OperationCallable<DeleteMembershipRequest,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")
.build();
OperationFuture<Empty, OperationMetadata> future =
gkeHubMembershipServiceClient.deleteMembershipOperationCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
OperationCallable<DeleteMembershipRequest,Empty,OperationMetadata> |
generateConnectManifest(GenerateConnectManifestRequest request)
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);
}
Name | Description |
request | GenerateConnectManifestRequest The request object containing all of the parameters for the API call. |
Type | Description |
GenerateConnectManifestResponse |
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();
}
Type | Description |
UnaryCallable<GenerateConnectManifestRequest,GenerateConnectManifestResponse> |
generateExclusivityManifest(GenerateExclusivityManifestRequest request)
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);
}
Name | Description |
request | GenerateExclusivityManifestRequest The request object containing all of the parameters for the API call. |
Type | Description |
GenerateExclusivityManifestResponse |
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();
}
Type | Description |
UnaryCallable<GenerateExclusivityManifestRequest,GenerateExclusivityManifestResponse> |
getHttpJsonOperationsClient()
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.
Type | Description |
OperationsClient |
getIamPolicy(GetIamPolicyRequest request)
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);
}
Name | Description |
request | com.google.iam.v1.GetIamPolicyRequest The request object containing all of the parameters for the API call. |
Type | Description |
com.google.iam.v1.Policy |
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();
}
Type | Description |
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
getLocation(GetLocationRequest request)
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);
}
Name | Description |
request | com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call. |
Type | Description |
com.google.cloud.location.Location |
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();
}
Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getMembership(GetMembershipRequest request)
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);
}
Name | Description |
request | GetMembershipRequest The request object containing all of the parameters for the API call. |
Type | Description |
Membership |
getMembership(MembershipName name)
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);
}
Name | Description |
name | MembershipName Required. The Membership resource name in the format
|
Type | Description |
Membership |
getMembership(String name)
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);
}
Name | Description |
name | String Required. The Membership resource name in the format
|
Type | Description |
Membership |
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();
}
Type | Description |
UnaryCallable<GetMembershipRequest,Membership> |
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.
Type | Description |
OperationsClient |
getSettings()
public final GkeHubMembershipServiceSettings getSettings()
Type | Description |
GkeHubMembershipServiceSettings |
getStub()
public GkeHubMembershipServiceStub getStub()
Type | Description |
GkeHubMembershipServiceStub |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
listLocations(ListLocationsRequest request)
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);
}
}
Name | Description |
request | com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call. |
Type | Description |
GkeHubMembershipServiceClient.ListLocationsPagedResponse |
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;
}
}
}
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
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);
}
}
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
listMemberships(ListMembershipsRequest request)
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);
}
}
Name | Description |
request | ListMembershipsRequest The request object containing all of the parameters for the API call. |
Type | Description |
GkeHubMembershipServiceClient.ListMembershipsPagedResponse |
listMemberships(LocationName parent)
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);
}
}
Name | Description |
parent | LocationName Required. The parent (project and location) where the Memberships will be listed.
Specified in the format |
Type | Description |
GkeHubMembershipServiceClient.ListMembershipsPagedResponse |
listMemberships(String parent)
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);
}
}
Name | Description |
parent | String Required. The parent (project and location) where the Memberships will be listed.
Specified in the format |
Type | Description |
GkeHubMembershipServiceClient.ListMembershipsPagedResponse |
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;
}
}
}
Type | Description |
UnaryCallable<ListMembershipsRequest,ListMembershipsResponse> |
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);
}
}
Type | Description |
UnaryCallable<ListMembershipsRequest,ListMembershipsPagedResponse> |
setIamPolicy(SetIamPolicyRequest request)
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);
}
Name | Description |
request | com.google.iam.v1.SetIamPolicyRequest The request object containing all of the parameters for the API call. |
Type | Description |
com.google.iam.v1.Policy |
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();
}
Type | Description |
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
testIamPermissions(TestIamPermissionsRequest request)
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);
}
Name | Description |
request | com.google.iam.v1.TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
Type | Description |
com.google.iam.v1.TestIamPermissionsResponse |
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();
}
Type | Description |
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
updateMembershipAsync(MembershipName name, Membership resource, FieldMask updateMask)
public final OperationFuture<Membership,OperationMetadata> updateMembershipAsync(MembershipName name, Membership resource, 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();
}
Name | Description |
name | MembershipName Required. The membership resource name in the format:
|
resource | Membership 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 |
updateMask | FieldMask Required. Mask of fields to update. At least one field path must be specified in this mask. |
Type | Description |
OperationFuture<Membership,OperationMetadata> |
updateMembershipAsync(UpdateMembershipRequest request)
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();
}
Name | Description |
request | UpdateMembershipRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Membership,OperationMetadata> |
updateMembershipAsync(String name, Membership resource, FieldMask updateMask)
public final OperationFuture<Membership,OperationMetadata> updateMembershipAsync(String name, Membership resource, 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();
}
Name | Description |
name | String Required. The membership resource name in the format:
|
resource | Membership 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 |
updateMask | FieldMask Required. Mask of fields to update. At least one field path must be specified in this mask. |
Type | Description |
OperationFuture<Membership,OperationMetadata> |
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();
}
Type | Description |
UnaryCallable<UpdateMembershipRequest,Operation> |
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();
}
Type | Description |
OperationCallable<UpdateMembershipRequest,Membership,OperationMetadata> |
validateExclusivity(ValidateExclusivityRequest request)
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);
}
Name | Description |
request | ValidateExclusivityRequest The request object containing all of the parameters for the API call. |
Type | Description |
ValidateExclusivityResponse |
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();
}
Type | Description |
UnaryCallable<ValidateExclusivityRequest,ValidateExclusivityResponse> |