Class PartitionAssignmentServiceClient (1.12.22)

public class PartitionAssignmentServiceClient implements BackgroundResource

Service 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:


 // 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 (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().

Methods
Method	Description	Method Variants
AssignPartitions	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.	Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. assignPartitionsCallable()

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:


 // 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
 PartitionAssignmentServiceSettings partitionAssignmentServiceSettings =
     PartitionAssignmentServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PartitionAssignmentServiceClient partitionAssignmentServiceClient =
     PartitionAssignmentServiceClient.create(partitionAssignmentServiceSettings);

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
 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.

Inheritance

java.lang.Object > PartitionAssignmentServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final PartitionAssignmentServiceClient create()

Constructs an instance of PartitionAssignmentServiceClient with default settings.

Returns
Type	Description
`PartitionAssignmentServiceClient`

Exceptions
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.

Parameter
Name	Description
`settings`	`PartitionAssignmentServiceSettings`

Returns
Type	Description
`PartitionAssignmentServiceClient`

Exceptions
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).

Parameter
Name	Description
`stub`	`PartitionAssignmentServiceStub`

Returns
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.

Parameter
Name	Description
`settings`	`PartitionAssignmentServiceSettings`

PartitionAssignmentServiceClient(PartitionAssignmentServiceStub stub)

protected PartitionAssignmentServiceClient(PartitionAssignmentServiceStub stub)

Parameter
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:


 // 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 (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.
   }
 }

Returns
Type	Description
`BidiStreamingCallable<PartitionAssignmentRequest,PartitionAssignment>`

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()

getSettings()

public final PartitionAssignmentServiceSettings getSettings()

Returns
Type	Description
`PartitionAssignmentServiceSettings`

getStub()

public PartitionAssignmentServiceStub getStub()

Returns
Type	Description
`PartitionAssignmentServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()