GatewayServiceClient (Google Connect Gateway API 0.7.0 API)

java.lang.Object
- com.google.cloud.gkeconnect.gateway.v1beta1.GatewayServiceClient

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

@BetaApi
 @Generated(value="by gapic-generator-java")
public class GatewayServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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:


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

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 GatewayServiceSettings 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
 GatewayServiceSettings gatewayServiceSettings =
     GatewayServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create(gatewayServiceSettings);

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

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`GatewayServiceClient(GatewayServiceSettings settings)` Constructs an instance of GatewayServiceClient, using the given settings.
`protected`	`GatewayServiceClient(GatewayServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static GatewayServiceClient`	`create()` Constructs an instance of GatewayServiceClient with default settings.
`static GatewayServiceClient`	`create(GatewayServiceSettings settings)` Constructs an instance of GatewayServiceClient, using the given settings.
`static GatewayServiceClient`	`create(GatewayServiceStub stub)` Constructs an instance of GatewayServiceClient, using the given stub for making calls.
`com.google.api.HttpBody`	`deleteResource(com.google.api.HttpBody request)` DeleteResource performs an HTTP DELETE on the Kubernetes API Server.
`com.google.api.gax.rpc.UnaryCallable<com.google.api.HttpBody,com.google.api.HttpBody>`	`deleteResourceCallable()` DeleteResource performs an HTTP DELETE on the Kubernetes API Server.
`com.google.api.HttpBody`	`getResource(com.google.api.HttpBody request)` GetResource performs an HTTP GET request on the Kubernetes API Server.
`com.google.api.gax.rpc.UnaryCallable<com.google.api.HttpBody,com.google.api.HttpBody>`	`getResourceCallable()` GetResource performs an HTTP GET request on the Kubernetes API Server.
`GatewayServiceSettings`	`getSettings()`
`GatewayServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`com.google.api.HttpBody`	`patchResource(com.google.api.HttpBody request)` PatchResource performs an HTTP PATCH on the Kubernetes API Server.
`com.google.api.gax.rpc.UnaryCallable<com.google.api.HttpBody,com.google.api.HttpBody>`	`patchResourceCallable()` PatchResource performs an HTTP PATCH on the Kubernetes API Server.
`com.google.api.HttpBody`	`postResource(com.google.api.HttpBody request)` PostResource performs an HTTP POST on the Kubernetes API Server.
`com.google.api.gax.rpc.UnaryCallable<com.google.api.HttpBody,com.google.api.HttpBody>`	`postResourceCallable()` PostResource performs an HTTP POST on the Kubernetes API Server.
`com.google.api.HttpBody`	`putResource(com.google.api.HttpBody request)` PutResource performs an HTTP PUT on the Kubernetes API Server.
`com.google.api.gax.rpc.UnaryCallable<com.google.api.HttpBody,com.google.api.HttpBody>`	`putResourceCallable()` PutResource performs an HTTP PUT on the Kubernetes API Server.
`void`	`shutdown()`
`void`	`shutdownNow()`

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

Constructor Detail
- GatewayServiceClient
```
protected GatewayServiceClient(GatewayServiceSettings settings)
                        throws IOException
```
  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.
  
  Throws:
  
  IOException
- GatewayServiceClient
```
protected GatewayServiceClient(GatewayServiceStub stub)
```

Method Detail

create

public static final GatewayServiceClient create()
                                         throws IOException

Constructs an instance of GatewayServiceClient with default settings.

Throws:: IOException

create
```
public static final GatewayServiceClient create(GatewayServiceSettings settings)
                                         throws IOException
```
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.

Throws:

IOException

create
```
public static final GatewayServiceClient create(GatewayServiceStub stub)
```
Constructs an instance of GatewayServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(GatewayServiceSettings).

getSettings

public final GatewayServiceSettings getSettings()

getStub
```
public GatewayServiceStub getStub()
```

getResource

public final com.google.api.HttpBody getResource(com.google.api.HttpBody request)

GetResource performs an HTTP GET request on the Kubernetes API Server.

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 (GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create()) {
   HttpBody request =
       HttpBody.newBuilder()
           .setContentType("contentType-389131437")
           .setData(ByteString.EMPTY)
           .addAllExtensions(new ArrayList<Any>())
           .build();
   HttpBody response = gatewayServiceClient.getResource(request);
 }

Parameters:: 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

getResourceCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.api.HttpBody,com.google.api.HttpBody> getResourceCallable()

GetResource performs an HTTP GET request on the Kubernetes API Server.

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 (GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create()) {
   HttpBody request =
       HttpBody.newBuilder()
           .setContentType("contentType-389131437")
           .setData(ByteString.EMPTY)
           .addAllExtensions(new ArrayList<Any>())
           .build();
   ApiFuture<HttpBody> future = gatewayServiceClient.getResourceCallable().futureCall(request);
   // Do something.
   HttpBody response = future.get();
 }

postResource

public final com.google.api.HttpBody postResource(com.google.api.HttpBody request)

PostResource performs an HTTP POST on the Kubernetes API Server.

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 (GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create()) {
   HttpBody request =
       HttpBody.newBuilder()
           .setContentType("contentType-389131437")
           .setData(ByteString.EMPTY)
           .addAllExtensions(new ArrayList<Any>())
           .build();
   HttpBody response = gatewayServiceClient.postResource(request);
 }

Parameters:: 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

postResourceCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.api.HttpBody,com.google.api.HttpBody> postResourceCallable()

PostResource performs an HTTP POST on the Kubernetes API Server.

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 (GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create()) {
   HttpBody request =
       HttpBody.newBuilder()
           .setContentType("contentType-389131437")
           .setData(ByteString.EMPTY)
           .addAllExtensions(new ArrayList<Any>())
           .build();
   ApiFuture<HttpBody> future = gatewayServiceClient.postResourceCallable().futureCall(request);
   // Do something.
   HttpBody response = future.get();
 }

deleteResource

public final com.google.api.HttpBody deleteResource(com.google.api.HttpBody request)

DeleteResource performs an HTTP DELETE on the Kubernetes API Server.

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 (GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create()) {
   HttpBody request =
       HttpBody.newBuilder()
           .setContentType("contentType-389131437")
           .setData(ByteString.EMPTY)
           .addAllExtensions(new ArrayList<Any>())
           .build();
   HttpBody response = gatewayServiceClient.deleteResource(request);
 }

Parameters:: 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

deleteResourceCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.api.HttpBody,com.google.api.HttpBody> deleteResourceCallable()

DeleteResource performs an HTTP DELETE on the Kubernetes API Server.

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 (GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create()) {
   HttpBody request =
       HttpBody.newBuilder()
           .setContentType("contentType-389131437")
           .setData(ByteString.EMPTY)
           .addAllExtensions(new ArrayList<Any>())
           .build();
   ApiFuture<HttpBody> future =
       gatewayServiceClient.deleteResourceCallable().futureCall(request);
   // Do something.
   HttpBody response = future.get();
 }

putResource

public final com.google.api.HttpBody putResource(com.google.api.HttpBody request)

PutResource performs an HTTP PUT on the Kubernetes API Server.

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 (GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create()) {
   HttpBody request =
       HttpBody.newBuilder()
           .setContentType("contentType-389131437")
           .setData(ByteString.EMPTY)
           .addAllExtensions(new ArrayList<Any>())
           .build();
   HttpBody response = gatewayServiceClient.putResource(request);
 }

Parameters:: 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

putResourceCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.api.HttpBody,com.google.api.HttpBody> putResourceCallable()

PutResource performs an HTTP PUT on the Kubernetes API Server.

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 (GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create()) {
   HttpBody request =
       HttpBody.newBuilder()
           .setContentType("contentType-389131437")
           .setData(ByteString.EMPTY)
           .addAllExtensions(new ArrayList<Any>())
           .build();
   ApiFuture<HttpBody> future = gatewayServiceClient.putResourceCallable().futureCall(request);
   // Do something.
   HttpBody response = future.get();
 }

patchResource

public final com.google.api.HttpBody patchResource(com.google.api.HttpBody request)

PatchResource performs an HTTP PATCH on the Kubernetes API Server.

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 (GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create()) {
   HttpBody request =
       HttpBody.newBuilder()
           .setContentType("contentType-389131437")
           .setData(ByteString.EMPTY)
           .addAllExtensions(new ArrayList<Any>())
           .build();
   HttpBody response = gatewayServiceClient.patchResource(request);
 }

Parameters:: 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

patchResourceCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.api.HttpBody,com.google.api.HttpBody> patchResourceCallable()

PatchResource performs an HTTP PATCH on the Kubernetes API Server.

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 (GatewayServiceClient gatewayServiceClient = GatewayServiceClient.create()) {
   HttpBody request =
       HttpBody.newBuilder()
           .setContentType("contentType-389131437")
           .setData(ByteString.EMPTY)
           .addAllExtensions(new ArrayList<Any>())
           .build();
   ApiFuture<HttpBody> future = gatewayServiceClient.patchResourceCallable().futureCall(request);
   // Do something.
   HttpBody response = future.get();
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class GatewayServiceClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GatewayServiceClient

GatewayServiceClient

Method Detail

create

create

create

getSettings

getStub

getResource

getResourceCallable

postResource

postResourceCallable

deleteResource

deleteResourceCallable

putResource

putResourceCallable

patchResource

patchResourceCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination