| GitHub Repository | Product Reference |
Service Description: Tether provides a way for the control plane to send HTTP API requests to services in data planes that runs in a remote datacenter without requiring customers to open firewalls on their runtime plane.
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 (TetherClient tetherClient = TetherClient.create()) {
BidiStream<EgressResponse, EgressRequest> bidiStream = tetherClient.egressCallable().call();
EgressResponse request =
EgressResponse.newBuilder()
.setId("id3355")
.setHttpResponse(HttpResponse.newBuilder().build())
.setStatus(Status.newBuilder().build())
.setProject("project-309310695")
.setTraceId("traceId-1067401920")
.setEndpoint(TetherEndpoint.forNumber(0))
.setName("name3373707")
.build();
bidiStream.send(request);
for (EgressRequest response : bidiStream) {
// Do something when a response is received.
}
}
Note: close() needs to be called on the TetherClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
| Method | Description | Method Variants |
|---|---|---|
Egress |
Egress streams egress requests and responses. Logically, this is not actually a streaming request, but uses streaming as a mechanism to flip the client-server relationship of gRPC so that the server can act as a client. The listener, the RPC server, accepts connections from the dialer, the RPC client. The listener streams http requests and the dialer streams http responses. |
Callable method variants take no parameters and return 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 TetherSettings 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
TetherSettings tetherSettings =
TetherSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
TetherClient tetherClient = TetherClient.create(tetherSettings);
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
TetherSettings tetherSettings = TetherSettings.newBuilder().setEndpoint(myEndpoint).build();
TetherClient tetherClient = TetherClient.create(tetherSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final TetherClient create()Constructs an instance of TetherClient with default settings.
| Returns | |
|---|---|
| Type | Description |
TetherClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(TetherSettings settings)
public static final TetherClient create(TetherSettings settings)Constructs an instance of TetherClient, 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 |
TetherSettings |
| Returns | |
|---|---|
| Type | Description |
TetherClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(TetherStub stub)
public static final TetherClient create(TetherStub stub)Constructs an instance of TetherClient, using the given stub for making calls. This is for advanced usage - prefer using create(TetherSettings).
| Parameter | |
|---|---|
| Name | Description |
stub |
TetherStub |
| Returns | |
|---|---|
| Type | Description |
TetherClient |
|
Constructors
TetherClient(TetherSettings settings)
protected TetherClient(TetherSettings settings)Constructs an instance of TetherClient, 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 |
TetherSettings |
TetherClient(TetherStub stub)
protected TetherClient(TetherStub stub)| Parameter | |
|---|---|
| Name | Description |
stub |
TetherStub |
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()egressCallable()
public final BidiStreamingCallable<EgressResponse,EgressRequest> egressCallable()Egress streams egress requests and responses. Logically, this is not actually a streaming request, but uses streaming as a mechanism to flip the client-server relationship of gRPC so that the server can act as a client. The listener, the RPC server, accepts connections from the dialer, the RPC client. The listener streams http requests and the dialer streams http responses.
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 (TetherClient tetherClient = TetherClient.create()) {
BidiStream<EgressResponse, EgressRequest> bidiStream = tetherClient.egressCallable().call();
EgressResponse request =
EgressResponse.newBuilder()
.setId("id3355")
.setHttpResponse(HttpResponse.newBuilder().build())
.setStatus(Status.newBuilder().build())
.setProject("project-309310695")
.setTraceId("traceId-1067401920")
.setEndpoint(TetherEndpoint.forNumber(0))
.setName("name3373707")
.build();
bidiStream.send(request);
for (EgressRequest response : bidiStream) {
// Do something when a response is received.
}
}
| Returns | |
|---|---|
| Type | Description |
BidiStreamingCallable<EgressResponse,EgressRequest> |
|
getSettings()
public final TetherSettings getSettings()| Returns | |
|---|---|
| Type | Description |
TetherSettings |
|
getStub()
public TetherStub getStub()| Returns | |
|---|---|
| Type | Description |
TetherStub |
|
isShutdown()
public boolean isShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
public boolean isTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()