Class LookupServiceClient

public class LookupServiceClient implements BackgroundResource

Service Description: Service Directory API for looking up service data at runtime.

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:


 try (LookupServiceClient lookupServiceClient = LookupServiceClient.create()) {
   ResolveServiceRequest request =
       ResolveServiceRequest.newBuilder()
           .setName(
               ServiceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]").toString())
           .setMaxEndpoints(2074789987)
           .setEndpointFilter("endpointFilter-1834249875")
           .build();
   ResolveServiceResponse response = lookupServiceClient.resolveService(request);
 }

Note: close() needs to be called on the LookupServiceClient 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:

  1. 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.
  2. 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.
  3. 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 LookupServiceSettings to create(). For example:

To customize credentials:


 LookupServiceSettings lookupServiceSettings =
     LookupServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 LookupServiceClient lookupServiceClient = LookupServiceClient.create(lookupServiceSettings);

To customize the endpoint:


 LookupServiceSettings lookupServiceSettings =
     LookupServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 LookupServiceClient lookupServiceClient = LookupServiceClient.create(lookupServiceSettings);

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

Inheritance

java.lang.Object > LookupServiceClient

Implements

BackgroundResource

Static Methods

create()

public static final LookupServiceClient create()

Constructs an instance of LookupServiceClient with default settings.

Returns
TypeDescription
LookupServiceClient
Exceptions
TypeDescription
IOException

create(LookupServiceSettings settings)

public static final LookupServiceClient create(LookupServiceSettings settings)

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

Parameter
NameDescription
settingsLookupServiceSettings
Returns
TypeDescription
LookupServiceClient
Exceptions
TypeDescription
IOException

create(LookupServiceStub stub)

public static final LookupServiceClient create(LookupServiceStub stub)

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

Parameter
NameDescription
stubLookupServiceStub
Returns
TypeDescription
LookupServiceClient

Constructors

LookupServiceClient(LookupServiceSettings settings)

protected LookupServiceClient(LookupServiceSettings settings)

Constructs an instance of LookupServiceClient, 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
NameDescription
settingsLookupServiceSettings

LookupServiceClient(LookupServiceStub stub)

protected LookupServiceClient(LookupServiceStub stub)
Parameter
NameDescription
stubLookupServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

getSettings()

public final LookupServiceSettings getSettings()
Returns
TypeDescription
LookupServiceSettings

getStub()

public LookupServiceStub getStub()
Returns
TypeDescription
LookupServiceStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

resolveService(ResolveServiceRequest request)

public final ResolveServiceResponse resolveService(ResolveServiceRequest request)

Returns a service and its associated endpoints. Resolving a service is not considered an active developer method.

Sample code:


 try (LookupServiceClient lookupServiceClient = LookupServiceClient.create()) {
   ResolveServiceRequest request =
       ResolveServiceRequest.newBuilder()
           .setName(
               ServiceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]").toString())
           .setMaxEndpoints(2074789987)
           .setEndpointFilter("endpointFilter-1834249875")
           .build();
   ResolveServiceResponse response = lookupServiceClient.resolveService(request);
 }
Parameter
NameDescription
requestResolveServiceRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
ResolveServiceResponse

resolveServiceCallable()

public final UnaryCallable<ResolveServiceRequest,ResolveServiceResponse> resolveServiceCallable()

Returns a service and its associated endpoints. Resolving a service is not considered an active developer method.

Sample code:


 try (LookupServiceClient lookupServiceClient = LookupServiceClient.create()) {
   ResolveServiceRequest request =
       ResolveServiceRequest.newBuilder()
           .setName(
               ServiceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]").toString())
           .setMaxEndpoints(2074789987)
           .setEndpointFilter("endpointFilter-1834249875")
           .build();
   ApiFuture
Returns
TypeDescription
UnaryCallable<ResolveServiceRequest,ResolveServiceResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()