ServiceClient Interface
Implements
public interface ServiceClient
implements Annotation
Annotation given to all service client classes.
Method Summary
| Modifier and Type | Method and Description |
|---|---|
| abstract Class<?> |
builder()
The builder class that can construct an instance of this class. |
| abstract boolean |
isAsync()
Represents whether the network IO methods on this client will be performed asynchronously or synchronously (i. |
| abstract Class<?>[] |
serviceInterfaces()
Optional field to indicate all the services this service client interacts with. |
Method Details
builder
public abstract Class builder()
The builder class that can construct an instance of this class. All service clients are instantiated using a builder and this is a required field. Also, builders should be annotated with ServiceClientBuilder.
Returns:
isAsync
public abstract boolean isAsync()
Represents whether the network IO methods on this client will be performed asynchronously or synchronously (i.e. blocking).
Returns:
true is the Service Client is asynchronous.serviceInterfaces
public abstract Class[] serviceInterfaces()
Optional field to indicate all the services this service client interacts with. All classes mentioned in this list should be annotated with ServiceInterface. Typically, there's one service associated with each client. However, there could be zero to N services associated with a single client.
Returns:
