Class GatewayControlClient (0.52.0)

Service Description: GatewayControl is the control plane API for Connect Gateway.

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 (GatewayControlClient gatewayControlClient = GatewayControlClient.create()) {
   GenerateCredentialsRequest request =
       GenerateCredentialsRequest.newBuilder()
           .setName("name3373707")
           .setForceUseAgent(true)
           .setVersion("version351608024")
           .setKubernetesNamespace("kubernetesNamespace-1862862667")
           .build();
   GenerateCredentialsResponse response = gatewayControlClient.generateCredentials(request);
 }

Note: close() needs to be called on the GatewayControlClient 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
GenerateCredentials	GenerateCredentials provides connection information that allows a user to access the specified membership using Connect Gateway.	Request object method variants only take one parameter, a request object, which must be constructed before the call. generateCredentials(GenerateCredentialsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. generateCredentialsCallable()

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 GatewayControlSettings 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
 GatewayControlSettings gatewayControlSettings =
     GatewayControlSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 GatewayControlClient gatewayControlClient = GatewayControlClient.create(gatewayControlSettings);

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
 GatewayControlSettings gatewayControlSettings =
     GatewayControlSettings.newBuilder().setEndpoint(myEndpoint).build();
 GatewayControlClient gatewayControlClient = GatewayControlClient.create(gatewayControlSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > GatewayControlClient

Static Methods

create()

public static final GatewayControlClient create()

Constructs an instance of GatewayControlClient with default settings.

Returns
Type	Description
`GatewayControlClient`

Exceptions
Type	Description
`IOException`

create(GatewayControlSettings settings)

public static final GatewayControlClient create(GatewayControlSettings settings)

Constructs an instance of GatewayControlClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
`settings`	`GatewayControlSettings`

Returns
Type	Description
`GatewayControlClient`

Exceptions
Type	Description
`IOException`

create(GatewayControlStub stub)

public static final GatewayControlClient create(GatewayControlStub stub)

Constructs an instance of GatewayControlClient, using the given stub for making calls. This is for advanced usage - prefer using create(GatewayControlSettings).

Parameter
Name	Description
`stub`	`GatewayControlStub`

Returns
Type	Description
`GatewayControlClient`

Constructors

GatewayControlClient(GatewayControlSettings settings)

protected GatewayControlClient(GatewayControlSettings settings)

Constructs an instance of GatewayControlClient, 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.

Parameter
Name	Description
`settings`	`GatewayControlSettings`

GatewayControlClient(GatewayControlStub stub)

protected GatewayControlClient(GatewayControlStub stub)

Parameter
Name	Description
`stub`	`GatewayControlStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

generateCredentials(GenerateCredentialsRequest request)

public final GenerateCredentialsResponse generateCredentials(GenerateCredentialsRequest request)

GenerateCredentials provides connection information that allows a user to access the specified membership using Connect Gateway.

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 (GatewayControlClient gatewayControlClient = GatewayControlClient.create()) {
   GenerateCredentialsRequest request =
       GenerateCredentialsRequest.newBuilder()
           .setName("name3373707")
           .setForceUseAgent(true)
           .setVersion("version351608024")
           .setKubernetesNamespace("kubernetesNamespace-1862862667")
           .build();
   GenerateCredentialsResponse response = gatewayControlClient.generateCredentials(request);
 }

Parameter
Name	Description
`request`	`GenerateCredentialsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`GenerateCredentialsResponse`

generateCredentialsCallable()

public final UnaryCallable<GenerateCredentialsRequest,GenerateCredentialsResponse> generateCredentialsCallable()

GenerateCredentials provides connection information that allows a user to access the specified membership using Connect Gateway.

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 (GatewayControlClient gatewayControlClient = GatewayControlClient.create()) {
   GenerateCredentialsRequest request =
       GenerateCredentialsRequest.newBuilder()
           .setName("name3373707")
           .setForceUseAgent(true)
           .setVersion("version351608024")
           .setKubernetesNamespace("kubernetesNamespace-1862862667")
           .build();
   ApiFuture<GenerateCredentialsResponse> future =
       gatewayControlClient.generateCredentialsCallable().futureCall(request);
   // Do something.
   GenerateCredentialsResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GenerateCredentialsRequest,GenerateCredentialsResponse>`

getSettings()

public final GatewayControlSettings getSettings()

Returns
Type	Description
`GatewayControlSettings`

getStub()

public GatewayControlStub getStub()

Returns
Type	Description
`GatewayControlStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()