com.google.cloud.gkehub.v1alpha.GkeHubClient Maven / Gradle / Ivy
Show all versions of google-cloud-gkehub Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.gkehub.v1alpha;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.httpjson.longrunning.OperationsClient;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.gkehub.v1alpha.stub.GkeHubStub;
import com.google.cloud.gkehub.v1alpha.stub.GkeHubStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.longrunning.Operation;
import com.google.protobuf.Empty;
import com.google.protobuf.FieldMask;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: The GKE Hub service handles the registration of many Kubernetes clusters to
* Google Cloud, and the management of multi-cluster features over those clusters.
*
* The GKE Hub service operates on the following resources:
*
*
* - [Membership][google.cloud.gkehub.v1alpha.Membership]
*
- [Feature][google.cloud.gkehub.v1alpha.Feature]
*
*
* 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:
*
*
{@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 (GkeHubClient gkeHubClient = GkeHubClient.create()) {
* String name = "name3373707";
* Feature response = gkeHubClient.getFeature(name);
* }
* }
*
* Note: close() needs to be called on the GkeHubClient 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
*
*
* ListFeatures
Lists Features in a given project and location.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listFeatures(ListFeaturesRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listFeatures(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.
*
* listFeaturesPagedCallable()
*
listFeaturesCallable()
*
*
*
*
* GetFeature
Gets details of a single Feature.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getFeature(GetFeatureRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getFeature(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.
*
* getFeatureCallable()
*
*
*
*
* CreateFeature
Adds a new Feature.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* createFeatureAsync(CreateFeatureRequest request)
*
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
*
* createFeatureAsync(String parent, Feature resource, String featureId)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createFeatureOperationCallable()
*
createFeatureCallable()
*
*
*
*
* DeleteFeature
Removes a Feature.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteFeatureAsync(DeleteFeatureRequest request)
*
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
*
* deleteFeatureAsync(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.
*
* deleteFeatureOperationCallable()
*
deleteFeatureCallable()
*
*
*
*
* UpdateFeature
Updates an existing Feature.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* updateFeatureAsync(UpdateFeatureRequest request)
*
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
*
* updateFeatureAsync(String name, Feature 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.
*
* updateFeatureOperationCallable()
*
updateFeatureCallable()
*
*
*
*
*
* 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 GkeHubSettings to create().
* For example:
*
*
To customize credentials:
*
*
{@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
* GkeHubSettings gkeHubSettings =
* GkeHubSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* GkeHubClient gkeHubClient = GkeHubClient.create(gkeHubSettings);
* }
*
* To customize the endpoint:
*
*
{@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
* GkeHubSettings gkeHubSettings = GkeHubSettings.newBuilder().setEndpoint(myEndpoint).build();
* GkeHubClient gkeHubClient = GkeHubClient.create(gkeHubSettings);
* }
*
* To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
* the wire:
*
*
{@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
* GkeHubSettings gkeHubSettings = GkeHubSettings.newHttpJsonBuilder().build();
* GkeHubClient gkeHubClient = GkeHubClient.create(gkeHubSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@BetaApi
@Generated("by gapic-generator-java")
public class GkeHubClient implements BackgroundResource {
private final GkeHubSettings settings;
private final GkeHubStub stub;
private final OperationsClient httpJsonOperationsClient;
private final com.google.longrunning.OperationsClient operationsClient;
/** Constructs an instance of GkeHubClient with default settings. */
public static final GkeHubClient create() throws IOException {
return create(GkeHubSettings.newBuilder().build());
}
/**
* Constructs an instance of GkeHubClient, using the given settings. The channels are created
* based on the settings passed in, or defaults for any settings that are not set.
*/
public static final GkeHubClient create(GkeHubSettings settings) throws IOException {
return new GkeHubClient(settings);
}
/**
* Constructs an instance of GkeHubClient, using the given stub for making calls. This is for
* advanced usage - prefer using create(GkeHubSettings).
*/
public static final GkeHubClient create(GkeHubStub stub) {
return new GkeHubClient(stub);
}
/**
* Constructs an instance of GkeHubClient, 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.
*/
protected GkeHubClient(GkeHubSettings settings) throws IOException {
this.settings = settings;
this.stub = ((GkeHubStubSettings) settings.getStubSettings()).createStub();
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
protected GkeHubClient(GkeHubStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
public final GkeHubSettings getSettings() {
return settings;
}
public GkeHubStub getStub() {
return stub;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
public final com.google.longrunning.OperationsClient getOperationsClient() {
return operationsClient;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
@BetaApi
public final OperationsClient getHttpJsonOperationsClient() {
return httpJsonOperationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists Features in a given project and location.
*
*
Sample code:
*
*
{@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 (GkeHubClient gkeHubClient = GkeHubClient.create()) {
* String parent = "parent-995424086";
* for (Feature element : gkeHubClient.listFeatures(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent The parent (project and location) where the Features will be listed. Specified in
* the format `projects/*/locations/*`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListFeaturesPagedResponse listFeatures(String parent) {
ListFeaturesRequest request = ListFeaturesRequest.newBuilder().setParent(parent).build();
return listFeatures(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists Features in a given project and location.
*
* Sample code:
*
*
{@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 (GkeHubClient gkeHubClient = GkeHubClient.create()) {
* ListFeaturesRequest request =
* ListFeaturesRequest.newBuilder()
* .setParent("parent-995424086")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setFilter("filter-1274492040")
* .setOrderBy("orderBy-1207110587")
* .build();
* for (Feature element : gkeHubClient.listFeatures(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListFeaturesPagedResponse listFeatures(ListFeaturesRequest request) {
return listFeaturesPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists Features in a given project and location.
*
* Sample code:
*
*
{@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 (GkeHubClient gkeHubClient = GkeHubClient.create()) {
* ListFeaturesRequest request =
* ListFeaturesRequest.newBuilder()
* .setParent("parent-995424086")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setFilter("filter-1274492040")
* .setOrderBy("orderBy-1207110587")
* .build();
* ApiFuture future = gkeHubClient.listFeaturesPagedCallable().futureCall(request);
* // Do something.
* for (Feature element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listFeaturesPagedCallable() {
return stub.listFeaturesPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists Features in a given project and location.
*
* Sample code:
*
*
{@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 (GkeHubClient gkeHubClient = GkeHubClient.create()) {
* ListFeaturesRequest request =
* ListFeaturesRequest.newBuilder()
* .setParent("parent-995424086")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setFilter("filter-1274492040")
* .setOrderBy("orderBy-1207110587")
* .build();
* while (true) {
* ListFeaturesResponse response = gkeHubClient.listFeaturesCallable().call(request);
* for (Feature element : response.getResourcesList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable listFeaturesCallable() {
return stub.listFeaturesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets details of a single Feature.
*
* Sample code:
*
*
{@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 (GkeHubClient gkeHubClient = GkeHubClient.create()) {
* String name = "name3373707";
* Feature response = gkeHubClient.getFeature(name);
* }
* }
*
* @param name The Feature resource name in the format
* `projects/*/locations/*/features/*`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Feature getFeature(String name) {
GetFeatureRequest request = GetFeatureRequest.newBuilder().setName(name).build();
return getFeature(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets details of a single Feature.
*
* Sample code:
*
*
{@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 (GkeHubClient gkeHubClient = GkeHubClient.create()) {
* GetFeatureRequest request = GetFeatureRequest.newBuilder().setName("name3373707").build();
* Feature response = gkeHubClient.getFeature(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Feature getFeature(GetFeatureRequest request) {
return getFeatureCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets details of a single Feature.
*
* Sample code:
*
*
{@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 (GkeHubClient gkeHubClient = GkeHubClient.create()) {
* GetFeatureRequest request = GetFeatureRequest.newBuilder().setName("name3373707").build();
* ApiFuture future = gkeHubClient.getFeatureCallable().futureCall(request);
* // Do something.
* Feature response = future.get();
* }
* }
*/
public final UnaryCallable getFeatureCallable() {
return stub.getFeatureCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Adds a new Feature.
*
* Sample code:
*
*
{@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 (GkeHubClient gkeHubClient = GkeHubClient.create()) {
* String parent = "parent-995424086";
* Feature resource = Feature.newBuilder().build();
* String featureId = "featureId-420503887";
* Feature response = gkeHubClient.createFeatureAsync(parent, resource, featureId).get();
* }
* }
*
* @param parent The parent (project and location) where the Feature will be created. Specified in
* the format `projects/*/locations/*`.
* @param resource The Feature resource to create.
* @param featureId The ID of the feature to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture createFeatureAsync(
String parent, Feature resource, String featureId) {
CreateFeatureRequest request =
CreateFeatureRequest.newBuilder()
.setParent(parent)
.setResource(resource)
.setFeatureId(featureId)
.build();
return createFeatureAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Adds a new Feature.
*
* Sample code:
*
*
{@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 (GkeHubClient gkeHubClient = GkeHubClient.create()) {
* CreateFeatureRequest request =
* CreateFeatureRequest.newBuilder()
* .setParent("parent-995424086")
* .setFeatureId("featureId-420503887")
* .setResource(Feature.newBuilder().build())
* .setRequestId("requestId693933066")
* .build();
* Feature response = gkeHubClient.createFeatureAsync(request).get();
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture createFeatureAsync(
CreateFeatureRequest request) {
return createFeatureOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Adds a new Feature.
*
* Sample code:
*
*
{@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 (GkeHubClient gkeHubClient = GkeHubClient.create()) {
* CreateFeatureRequest request =
* CreateFeatureRequest.newBuilder()
* .setParent("parent-995424086")
* .setFeatureId("featureId-420503887")
* .setResource(Feature.newBuilder().build())
* .setRequestId("requestId693933066")
* .build();
* OperationFuture future =
* gkeHubClient.createFeatureOperationCallable().futureCall(request);
* // Do something.
* Feature response = future.get();
* }
* }
*/
public final OperationCallable
createFeatureOperationCallable() {
return stub.createFeatureOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Adds a new Feature.
*
* Sample code:
*
*
{@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 (GkeHubClient gkeHubClient = GkeHubClient.create()) {
* CreateFeatureRequest request =
* CreateFeatureRequest.newBuilder()
* .setParent("parent-995424086")
* .setFeatureId("featureId-420503887")
* .setResource(Feature.newBuilder().build())
* .setRequestId("requestId693933066")
* .build();
* ApiFuture future = gkeHubClient.createFeatureCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable createFeatureCallable() {
return stub.createFeatureCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Removes a Feature.
*
* Sample code:
*
*
{@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 (GkeHubClient gkeHubClient = GkeHubClient.create()) {
* String name = "name3373707";
* gkeHubClient.deleteFeatureAsync(name).get();
* }
* }
*
* @param name The Feature resource name in the format
* `projects/*/locations/*/features/*`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture deleteFeatureAsync(String name) {
DeleteFeatureRequest request = DeleteFeatureRequest.newBuilder().setName(name).build();
return deleteFeatureAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Removes a Feature.
*
* Sample code:
*
*
{@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 (GkeHubClient gkeHubClient = GkeHubClient.create()) {
* DeleteFeatureRequest request =
* DeleteFeatureRequest.newBuilder()
* .setName("name3373707")
* .setForce(true)
* .setRequestId("requestId693933066")
* .build();
* gkeHubClient.deleteFeatureAsync(request).get();
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture deleteFeatureAsync(
DeleteFeatureRequest request) {
return deleteFeatureOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Removes a Feature.
*
* Sample code:
*
*
{@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 (GkeHubClient gkeHubClient = GkeHubClient.create()) {
* DeleteFeatureRequest request =
* DeleteFeatureRequest.newBuilder()
* .setName("name3373707")
* .setForce(true)
* .setRequestId("requestId693933066")
* .build();
* OperationFuture future =
* gkeHubClient.deleteFeatureOperationCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final OperationCallable
deleteFeatureOperationCallable() {
return stub.deleteFeatureOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Removes a Feature.
*
* Sample code:
*
*
{@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 (GkeHubClient gkeHubClient = GkeHubClient.create()) {
* DeleteFeatureRequest request =
* DeleteFeatureRequest.newBuilder()
* .setName("name3373707")
* .setForce(true)
* .setRequestId("requestId693933066")
* .build();
* ApiFuture future = gkeHubClient.deleteFeatureCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable deleteFeatureCallable() {
return stub.deleteFeatureCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an existing Feature.
*
* Sample code:
*
*
{@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 (GkeHubClient gkeHubClient = GkeHubClient.create()) {
* String name = "name3373707";
* Feature resource = Feature.newBuilder().build();
* FieldMask updateMask = FieldMask.newBuilder().build();
* Feature response = gkeHubClient.updateFeatureAsync(name, resource, updateMask).get();
* }
* }
*
* @param name The Feature resource name in the format
* `projects/*/locations/*/features/*`.
* @param resource 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`.
* @param updateMask Mask of fields to update.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture updateFeatureAsync(
String name, Feature resource, FieldMask updateMask) {
UpdateFeatureRequest request =
UpdateFeatureRequest.newBuilder()
.setName(name)
.setResource(resource)
.setUpdateMask(updateMask)
.build();
return updateFeatureAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an existing Feature.
*
* Sample code:
*
*
{@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 (GkeHubClient gkeHubClient = GkeHubClient.create()) {
* UpdateFeatureRequest request =
* UpdateFeatureRequest.newBuilder()
* .setName("name3373707")
* .setUpdateMask(FieldMask.newBuilder().build())
* .setResource(Feature.newBuilder().build())
* .setRequestId("requestId693933066")
* .build();
* Feature response = gkeHubClient.updateFeatureAsync(request).get();
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture updateFeatureAsync(
UpdateFeatureRequest request) {
return updateFeatureOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an existing Feature.
*
* Sample code:
*
*
{@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 (GkeHubClient gkeHubClient = GkeHubClient.create()) {
* UpdateFeatureRequest request =
* UpdateFeatureRequest.newBuilder()
* .setName("name3373707")
* .setUpdateMask(FieldMask.newBuilder().build())
* .setResource(Feature.newBuilder().build())
* .setRequestId("requestId693933066")
* .build();
* OperationFuture future =
* gkeHubClient.updateFeatureOperationCallable().futureCall(request);
* // Do something.
* Feature response = future.get();
* }
* }
*/
public final OperationCallable
updateFeatureOperationCallable() {
return stub.updateFeatureOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an existing Feature.
*
* Sample code:
*
*
{@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 (GkeHubClient gkeHubClient = GkeHubClient.create()) {
* UpdateFeatureRequest request =
* UpdateFeatureRequest.newBuilder()
* .setName("name3373707")
* .setUpdateMask(FieldMask.newBuilder().build())
* .setResource(Feature.newBuilder().build())
* .setRequestId("requestId693933066")
* .build();
* ApiFuture future = gkeHubClient.updateFeatureCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable updateFeatureCallable() {
return stub.updateFeatureCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class ListFeaturesPagedResponse
extends AbstractPagedListResponse<
ListFeaturesRequest,
ListFeaturesResponse,
Feature,
ListFeaturesPage,
ListFeaturesFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListFeaturesPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListFeaturesPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListFeaturesPagedResponse(ListFeaturesPage page) {
super(page, ListFeaturesFixedSizeCollection.createEmptyCollection());
}
}
public static class ListFeaturesPage
extends AbstractPage {
private ListFeaturesPage(
PageContext context,
ListFeaturesResponse response) {
super(context, response);
}
private static ListFeaturesPage createEmptyPage() {
return new ListFeaturesPage(null, null);
}
@Override
protected ListFeaturesPage createPage(
PageContext context,
ListFeaturesResponse response) {
return new ListFeaturesPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListFeaturesFixedSizeCollection
extends AbstractFixedSizeCollection<
ListFeaturesRequest,
ListFeaturesResponse,
Feature,
ListFeaturesPage,
ListFeaturesFixedSizeCollection> {
private ListFeaturesFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListFeaturesFixedSizeCollection createEmptyCollection() {
return new ListFeaturesFixedSizeCollection(null, 0);
}
@Override
protected ListFeaturesFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListFeaturesFixedSizeCollection(pages, collectionSize);
}
}
}