public class PartitionAssignmentServiceClient implements BackgroundResourceService Description: The service that a subscriber client application uses to determine which partitions it should connect to.
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 (PartitionAssignmentServiceClient partitionAssignmentServiceClient =
PartitionAssignmentServiceClient.create()) {
BidiStream<PartitionAssignmentRequest, PartitionAssignment> bidiStream =
partitionAssignmentServiceClient.assignPartitionsCallable().call();
PartitionAssignmentRequest request = PartitionAssignmentRequest.newBuilder().build();
bidiStream.send(request);
for (PartitionAssignment response : bidiStream) {
// Do something when a response is received.
}
}
Note: close() needs to be called on the PartitionAssignmentServiceClient 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 PartitionAssignmentServiceSettings to create(). For example:
To customize credentials:
PartitionAssignmentServiceSettings partitionAssignmentServiceSettings =
PartitionAssignmentServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
PartitionAssignmentServiceClient partitionAssignmentServiceClient =
PartitionAssignmentServiceClient.create(partitionAssignmentServiceSettings);
To customize the endpoint:
PartitionAssignmentServiceSettings partitionAssignmentServiceSettings =
PartitionAssignmentServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
PartitionAssignmentServiceClient partitionAssignmentServiceClient =
PartitionAssignmentServiceClient.create(partitionAssignmentServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final PartitionAssignmentServiceClient create()Constructs an instance of PartitionAssignmentServiceClient with default settings.
| Type | Description |
| PartitionAssignmentServiceClient |
| Type | Description |
| IOException |
create(PartitionAssignmentServiceSettings settings)
public static final PartitionAssignmentServiceClient create(PartitionAssignmentServiceSettings settings)Constructs an instance of PartitionAssignmentServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
| Name | Description |
| settings | PartitionAssignmentServiceSettings |
| Type | Description |
| PartitionAssignmentServiceClient |
| Type | Description |
| IOException |
create(PartitionAssignmentServiceStub stub)
public static final PartitionAssignmentServiceClient create(PartitionAssignmentServiceStub stub)Constructs an instance of PartitionAssignmentServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(PartitionAssignmentServiceSettings).
| Name | Description |
| stub | PartitionAssignmentServiceStub |
| Type | Description |
| PartitionAssignmentServiceClient |
Constructors
PartitionAssignmentServiceClient(PartitionAssignmentServiceSettings settings)
protected PartitionAssignmentServiceClient(PartitionAssignmentServiceSettings settings)Constructs an instance of PartitionAssignmentServiceClient, 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.
| Name | Description |
| settings | PartitionAssignmentServiceSettings |
PartitionAssignmentServiceClient(PartitionAssignmentServiceStub stub)
protected PartitionAssignmentServiceClient(PartitionAssignmentServiceStub stub)| Name | Description |
| stub | PartitionAssignmentServiceStub |
Methods
assignPartitionsCallable()
public final BidiStreamingCallable<PartitionAssignmentRequest,PartitionAssignment> assignPartitionsCallable()Assign partitions for this client to handle for the specified subscription.
The client must send an InitialPartitionAssignmentRequest first. The server will then send at most one unacknowledged PartitionAssignment outstanding on the stream at a time. The client should send a PartitionAssignmentAck after updating the partitions it is connected to to reflect the new assignment.
Sample code:
try (PartitionAssignmentServiceClient partitionAssignmentServiceClient =
PartitionAssignmentServiceClient.create()) {
BidiStream<PartitionAssignmentRequest, PartitionAssignment> bidiStream =
partitionAssignmentServiceClient.assignPartitionsCallable().call();
PartitionAssignmentRequest request = PartitionAssignmentRequest.newBuilder().build();
bidiStream.send(request);
for (PartitionAssignment response : bidiStream) {
// Do something when a response is received.
}
}
| Type | Description |
| BidiStreamingCallable<PartitionAssignmentRequest,PartitionAssignment> |
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)| Name | Description |
| duration | long |
| unit | TimeUnit |
| Type | Description |
| boolean |
| Type | Description |
| InterruptedException |
close()
public final void close()getSettings()
public final PartitionAssignmentServiceSettings getSettings()| Type | Description |
| PartitionAssignmentServiceSettings |
getStub()
public PartitionAssignmentServiceStub getStub()| Type | Description |
| PartitionAssignmentServiceStub |
isShutdown()
public boolean isShutdown()| Type | Description |
| boolean |
isTerminated()
public boolean isTerminated()| Type | Description |
| boolean |
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()