com.google.cloud.pubsublite.v1

Class PartitionAssignmentServiceClient

java.lang.Object

com.google.cloud.pubsublite.v1.PartitionAssignmentServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class PartitionAssignmentServiceClient
extends Object
implements com.google.api.gax.core.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().

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PartitionAssignmentServiceClient(PartitionAssignmentServiceSettings settings) Constructs an instance of PartitionAssignmentServiceClient, using the given settings.
protected	PartitionAssignmentServiceClient(PartitionAssignmentServiceStub stub)

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.BidiStreamingCallable<PartitionAssignmentRequest,PartitionAssignment>	assignPartitionsCallable() Assign partitions for this client to handle for the specified subscription.
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static PartitionAssignmentServiceClient	create() Constructs an instance of PartitionAssignmentServiceClient with default settings.
static PartitionAssignmentServiceClient	create(PartitionAssignmentServiceSettings settings) Constructs an instance of PartitionAssignmentServiceClient, using the given settings.
static PartitionAssignmentServiceClient	create(PartitionAssignmentServiceStub stub) Constructs an instance of PartitionAssignmentServiceClient, using the given stub for making calls.
PartitionAssignmentServiceSettings	getSettings()
PartitionAssignmentServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PartitionAssignmentServiceClient

protected PartitionAssignmentServiceClient(PartitionAssignmentServiceSettings settings)
                                    throws IOException

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.

Throws:

IOException

PartitionAssignmentServiceClient

protected PartitionAssignmentServiceClient(PartitionAssignmentServiceStub stub)

Method Detail

create

public static final PartitionAssignmentServiceClient create()
                                                     throws IOException

Constructs an instance of PartitionAssignmentServiceClient with default settings.

Throws:

IOException

create

public static final PartitionAssignmentServiceClient create(PartitionAssignmentServiceSettings settings)
                                                     throws IOException

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.

Throws:

IOException

create

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

getSettings

public final PartitionAssignmentServiceSettings getSettings()

getStub

public PartitionAssignmentServiceStub getStub()

assignPartitionsCallable

public final com.google.api.gax.rpc.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.
   }
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException