com.google.cloud.gkeconnect.gateway.v1beta1.GatewayServiceClient Maven / Gradle / Ivy
Show all versions of google-cloud-gke-connect-gateway 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.gkeconnect.gateway.v1beta1;
import com.google.api.HttpBody;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.gkeconnect.gateway.v1beta1.stub.GatewayServiceStub;
import com.google.cloud.gkeconnect.gateway.v1beta1.stub.GatewayServiceStubSettings;
import java.io.IOException;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Gateway service is a public API which works as a Kubernetes resource model
* proxy between end users and registered Kubernetes clusters. Each RPC in this service matches with
* an HTTP verb. End user will initiate kubectl commands against the Gateway service, and Gateway
* service will forward user requests to clusters.
*
* 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 (GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create()) {
* HttpBody request =
* HttpBody.newBuilder()
* .setContentType("contentType-389131437")
* .setData(ByteString.EMPTY)
* .addAllExtensions(new ArrayList())
* .build();
* HttpBody response = gatewayServiceClient.getResource(request);
* }
* }
*
* Note: close() needs to be called on the GatewayServiceClient 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
*
*
* GetResource
GetResource performs an HTTP GET request on the Kubernetes API Server.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getResource(HttpBody request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getResourceCallable()
*
*
*
*
* PostResource
PostResource performs an HTTP POST on the Kubernetes API Server.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* postResource(HttpBody request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* postResourceCallable()
*
*
*
*
* DeleteResource
DeleteResource performs an HTTP DELETE on the Kubernetes API Server.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteResource(HttpBody request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* deleteResourceCallable()
*
*
*
*
* PutResource
PutResource performs an HTTP PUT on the Kubernetes API Server.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* putResource(HttpBody request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* putResourceCallable()
*
*
*
*
* PatchResource
PatchResource performs an HTTP PATCH on the Kubernetes API Server.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* patchResource(HttpBody request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* patchResourceCallable()
*
*
*
*
*
* 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 GatewayServiceSettings 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
* GatewayServiceSettings gatewayServiceSettings =
* GatewayServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create(gatewayServiceSettings);
* }
*
* 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
* GatewayServiceSettings gatewayServiceSettings =
* GatewayServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create(gatewayServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@BetaApi
@Generated("by gapic-generator-java")
public class GatewayServiceClient implements BackgroundResource {
private final GatewayServiceSettings settings;
private final GatewayServiceStub stub;
/** Constructs an instance of GatewayServiceClient with default settings. */
public static final GatewayServiceClient create() throws IOException {
return create(GatewayServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of GatewayServiceClient, 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 GatewayServiceClient create(GatewayServiceSettings settings)
throws IOException {
return new GatewayServiceClient(settings);
}
/**
* Constructs an instance of GatewayServiceClient, using the given stub for making calls. This is
* for advanced usage - prefer using create(GatewayServiceSettings).
*/
public static final GatewayServiceClient create(GatewayServiceStub stub) {
return new GatewayServiceClient(stub);
}
/**
* Constructs an instance of GatewayServiceClient, 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 GatewayServiceClient(GatewayServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((GatewayServiceStubSettings) settings.getStubSettings()).createStub();
}
protected GatewayServiceClient(GatewayServiceStub stub) {
this.settings = null;
this.stub = stub;
}
public final GatewayServiceSettings getSettings() {
return settings;
}
public GatewayServiceStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* GetResource performs an HTTP GET request on the Kubernetes API Server.
*
*
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 (GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create()) {
* HttpBody request =
* HttpBody.newBuilder()
* .setContentType("contentType-389131437")
* .setData(ByteString.EMPTY)
* .addAllExtensions(new ArrayList())
* .build();
* HttpBody response = gatewayServiceClient.getResource(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 HttpBody getResource(HttpBody request) {
return getResourceCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* GetResource performs an HTTP GET request on the Kubernetes API Server.
*
* 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 (GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create()) {
* HttpBody request =
* HttpBody.newBuilder()
* .setContentType("contentType-389131437")
* .setData(ByteString.EMPTY)
* .addAllExtensions(new ArrayList())
* .build();
* ApiFuture future = gatewayServiceClient.getResourceCallable().futureCall(request);
* // Do something.
* HttpBody response = future.get();
* }
* }
*/
public final UnaryCallable getResourceCallable() {
return stub.getResourceCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* PostResource performs an HTTP POST on the Kubernetes API Server.
*
* 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 (GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create()) {
* HttpBody request =
* HttpBody.newBuilder()
* .setContentType("contentType-389131437")
* .setData(ByteString.EMPTY)
* .addAllExtensions(new ArrayList())
* .build();
* HttpBody response = gatewayServiceClient.postResource(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 HttpBody postResource(HttpBody request) {
return postResourceCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* PostResource performs an HTTP POST on the Kubernetes API Server.
*
* 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 (GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create()) {
* HttpBody request =
* HttpBody.newBuilder()
* .setContentType("contentType-389131437")
* .setData(ByteString.EMPTY)
* .addAllExtensions(new ArrayList())
* .build();
* ApiFuture future = gatewayServiceClient.postResourceCallable().futureCall(request);
* // Do something.
* HttpBody response = future.get();
* }
* }
*/
public final UnaryCallable postResourceCallable() {
return stub.postResourceCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* DeleteResource performs an HTTP DELETE on the Kubernetes API Server.
*
* 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 (GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create()) {
* HttpBody request =
* HttpBody.newBuilder()
* .setContentType("contentType-389131437")
* .setData(ByteString.EMPTY)
* .addAllExtensions(new ArrayList())
* .build();
* HttpBody response = gatewayServiceClient.deleteResource(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 HttpBody deleteResource(HttpBody request) {
return deleteResourceCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* DeleteResource performs an HTTP DELETE on the Kubernetes API Server.
*
* 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 (GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create()) {
* HttpBody request =
* HttpBody.newBuilder()
* .setContentType("contentType-389131437")
* .setData(ByteString.EMPTY)
* .addAllExtensions(new ArrayList())
* .build();
* ApiFuture future =
* gatewayServiceClient.deleteResourceCallable().futureCall(request);
* // Do something.
* HttpBody response = future.get();
* }
* }
*/
public final UnaryCallable deleteResourceCallable() {
return stub.deleteResourceCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* PutResource performs an HTTP PUT on the Kubernetes API Server.
*
* 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 (GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create()) {
* HttpBody request =
* HttpBody.newBuilder()
* .setContentType("contentType-389131437")
* .setData(ByteString.EMPTY)
* .addAllExtensions(new ArrayList())
* .build();
* HttpBody response = gatewayServiceClient.putResource(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 HttpBody putResource(HttpBody request) {
return putResourceCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* PutResource performs an HTTP PUT on the Kubernetes API Server.
*
* 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 (GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create()) {
* HttpBody request =
* HttpBody.newBuilder()
* .setContentType("contentType-389131437")
* .setData(ByteString.EMPTY)
* .addAllExtensions(new ArrayList())
* .build();
* ApiFuture future = gatewayServiceClient.putResourceCallable().futureCall(request);
* // Do something.
* HttpBody response = future.get();
* }
* }
*/
public final UnaryCallable putResourceCallable() {
return stub.putResourceCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* PatchResource performs an HTTP PATCH on the Kubernetes API Server.
*
* 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 (GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create()) {
* HttpBody request =
* HttpBody.newBuilder()
* .setContentType("contentType-389131437")
* .setData(ByteString.EMPTY)
* .addAllExtensions(new ArrayList())
* .build();
* HttpBody response = gatewayServiceClient.patchResource(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 HttpBody patchResource(HttpBody request) {
return patchResourceCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* PatchResource performs an HTTP PATCH on the Kubernetes API Server.
*
* 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 (GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create()) {
* HttpBody request =
* HttpBody.newBuilder()
* .setContentType("contentType-389131437")
* .setData(ByteString.EMPTY)
* .addAllExtensions(new ArrayList())
* .build();
* ApiFuture future = gatewayServiceClient.patchResourceCallable().futureCall(request);
* // Do something.
* HttpBody response = future.get();
* }
* }
*/
public final UnaryCallable patchResourceCallable() {
return stub.patchResourceCallable();
}
@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);
}
}