PublisherServiceClient (Google Cloud Pub/Sub Lite 0.9.0 API)

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

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@BetaApi
 @Generated(value="by gapic-generator")
public class PublisherServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource
```
Service Description: The service that a publisher client application uses to publish messages to topics. Published messages are retained by the service for the duration of the retention period configured for the respective topic, and are delivered to subscriber clients upon request (via the `SubscriberService`).
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:
Note: close() needs to be called on the PublisherServiceClient 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 PublisherServiceSettings to create(). For example:
To customize credentials:
```
 PublisherServiceSettings publisherServiceSettings =
     PublisherServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PublisherServiceClient publisherServiceClient =
     PublisherServiceClient.create(publisherServiceSettings);
 
```
To customize the endpoint:
```
 PublisherServiceSettings publisherServiceSettings =
     PublisherServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 PublisherServiceClient publisherServiceClient =
     PublisherServiceClient.create(publisherServiceSettings);
 
```
Please refer to the GitHub repository's samples for more quickstart code snippets.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`PublisherServiceClient(PublisherServiceSettings settings)` Constructs an instance of PublisherServiceClient, using the given settings.
`protected`	`PublisherServiceClient(PublisherServiceStub 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 PublisherServiceClient`	`create()` Constructs an instance of PublisherServiceClient with default settings.
`static PublisherServiceClient`	`create(PublisherServiceSettings settings)` Constructs an instance of PublisherServiceClient, using the given settings.
`static PublisherServiceClient`	`create(PublisherServiceStub stub)` Constructs an instance of PublisherServiceClient, using the given stub for making calls.
`PublisherServiceSettings`	`getSettings()`
`PublisherServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`com.google.api.gax.rpc.BidiStreamingCallable<PublishRequest,PublishResponse>`	`publishCallable()` Establishes a stream with the server for publishing messages.
`void`	`shutdown()`
`void`	`shutdownNow()`

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

- Constructor Detail
  - PublisherServiceClient
```
protected PublisherServiceClient(PublisherServiceSettings settings)
                          throws IOException
```
    Constructs an instance of PublisherServiceClient, 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
  - PublisherServiceClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected PublisherServiceClient(PublisherServiceStub stub)
```
- Method Detail
  - create
```
public static final PublisherServiceClient create()
                                           throws IOException
```
    Constructs an instance of PublisherServiceClient with default settings.
    
    Throws:
    
    IOException
  - create
```
public static final PublisherServiceClient create(PublisherServiceSettings settings)
                                           throws IOException
```
    Constructs an instance of PublisherServiceClient, 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 PublisherServiceClient create(PublisherServiceStub stub)
```
    Constructs an instance of PublisherServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(PublisherServiceSettings).
  - getSettings
```
public final PublisherServiceSettings getSettings()
```
  - getStub
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public PublisherServiceStub getStub()
```
  - publishCallable
```
public final com.google.api.gax.rpc.BidiStreamingCallable<PublishRequest,PublishResponse> publishCallable()
```
    Establishes a stream with the server for publishing messages. Once the stream is initialized, the client publishes messages by sending publish requests on the stream. The server responds with a PublishResponse for each PublishRequest sent by the client, in the same order that the requests were sent. Note that multiple PublishRequests can be in flight simultaneously, but they will be processed by the server in the order that they are sent by the client on a given stream.
    Sample code:
  - 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 PublisherServiceClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PublisherServiceClient

PublisherServiceClient

Method Detail

create

create

create

getSettings

getStub

publishCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination