SubscriberServiceClient (Google Cloud Pub/Sub Lite 0.5.0 API)

java.lang.Object
- com.google.cloud.pubsublite.v1.SubscriberServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class SubscriberServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource
```
Service Description: The service that a subscriber client application uses to receive messages from subscriptions.
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 (SubscriberServiceClient subscriberServiceClient = SubscriberServiceClient.create()) {
   SubscribeRequest request = SubscribeRequest.newBuilder().build();
   ApiFuture<SubscribeResponse> future = subscriberServiceClient.subscribeCallable().futureCall(request);
   // Do something
   SubscribeResponse response = future.get();
 }
 
 
```
Note: close() needs to be called on the subscriberServiceClient 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 SubscriberServiceSettings to create(). For example:
To customize credentials:
```
 
 SubscriberServiceSettings subscriberServiceSettings =
     SubscriberServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SubscriberServiceClient subscriberServiceClient =
     SubscriberServiceClient.create(subscriberServiceSettings);
 
 
```
To customize the endpoint:
```
 
 SubscriberServiceSettings subscriberServiceSettings =
     SubscriberServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SubscriberServiceClient subscriberServiceClient =
     SubscriberServiceClient.create(subscriberServiceSettings);
 
 
```

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SubscriberServiceClient(SubscriberServiceSettings settings)` Constructs an instance of SubscriberServiceClient, using the given settings.
`protected`	`SubscriberServiceClient(SubscriberServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static SubscriberServiceClient`	`create()` Constructs an instance of SubscriberServiceClient with default settings.
`static SubscriberServiceClient`	`create(SubscriberServiceSettings settings)` Constructs an instance of SubscriberServiceClient, using the given settings.
`static SubscriberServiceClient`	`create(SubscriberServiceStub stub)` Constructs an instance of SubscriberServiceClient, using the given stub for making calls.
`SubscriberServiceSettings`	`getSettings()`
`SubscriberServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.api.gax.rpc.BidiStreamingCallable<SubscribeRequest,SubscribeResponse>`	`subscribeCallable()` Establishes a stream with the server for receiving messages.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- SubscriberServiceClient
```
protected SubscriberServiceClient(SubscriberServiceSettings settings)
                           throws IOException
```
  Constructs an instance of SubscriberServiceClient, 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
- SubscriberServiceClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected SubscriberServiceClient(SubscriberServiceStub stub)
```

Method Detail

create

public static final SubscriberServiceClient create()
                                            throws IOException

Constructs an instance of SubscriberServiceClient with default settings.

Throws:: IOException

create
```
public static final SubscriberServiceClient create(SubscriberServiceSettings settings)
                                            throws IOException
```
Constructs an instance of SubscriberServiceClient, 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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final SubscriberServiceClient create(SubscriberServiceStub stub)

Constructs an instance of SubscriberServiceClient, using the given stub for making calls. This is for advanced usage - prefer to use SubscriberServiceSettings}.

getSettings

public final SubscriberServiceSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public SubscriberServiceStub getStub()

subscribeCallable

public final com.google.api.gax.rpc.BidiStreamingCallable<SubscribeRequest,SubscribeResponse> subscribeCallable()

Establishes a stream with the server for receiving messages.

Sample code:


 try (SubscriberServiceClient subscriberServiceClient = SubscriberServiceClient.create()) {
   BidiStream<SubscribeRequest, SubscribeResponse> bidiStream =
       subscriberServiceClient.subscribeCallable().call();

   SubscribeRequest request = SubscribeRequest.newBuilder().build();
   bidiStream.send(request);
   for (SubscribeResponse response : bidiStream) {
     // Do something when receive a response
   }
 }

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

Class SubscriberServiceClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SubscriberServiceClient

SubscriberServiceClient

Method Detail

create

create

create

getSettings

getStub

subscribeCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination