Publisher (async-google-pubsub-client 1.31 API)

java.lang.Object
- com.spotify.google.cloud.pubsub.client.Publisher

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class Publisher
extends Object
implements Closeable
```
A tool for publishing larger volumes of messages to Google Pub/Sub. Does concurrent per-topic batching in order to provide good throughput with large volumes of messages across many different topics.
Messages are gathered into batches, bounded by specified batch size and maximum latency. The publisher waits up to the specified max latency before sending a batch of messages for a topic. If enough messages to fill a batch are submitted before the max latency deadline, then the batch is sent immediately.
This batching strategy trades publish request quota for increased publishing latency as outgoing messages might spend more time waiting in the publisher per-topic queues before getting sent. The rationale for this strategy is to avoid (expensive and empirically observed) excessive numbers of very small batch publish requests during off-peak.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Publisher.Builder` A builder that can be used to build a `Publisher`.
`static interface`	`Publisher.Listener` A listener for monitoring operations performed by the `Publisher`.
`static class`	`Publisher.ListenerAdapter`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`batchSize()` Get the max Google Pub/Sub request batch size.
`static Publisher.Builder`	`builder()` Create a builder that can be used to build a `Publisher`.
`void`	`close()` Close this `Publisher`.
`CompletableFuture<Void>`	`closeFuture()` Get a future that is completed when this `Publisher` is closed.
`int`	`concurrency()` Get the concurrent Google Pub/Sub request limit.
`int`	`outstandingRequests()` Get the current number of outstanding (batch) requests to Google Pub/Sub.
`int`	`pendingTopics()` Get the current number of topics that are pending batch sending to Google Pub/Sub.
`String`	`project()` Get the Google Cloud project this `Publisher` is publishing to.
`CompletableFuture<String>`	`publish(String topic, Message message)` Publish a message on a specific topic.
`int`	`queueSize()` Get the per-topic queue size.
`int`	`scheduledQueueSize()` Get the total number of scheduled requests.
`int`	`topicQueueSize(String topic)` Get the current queue size for the given topic name.

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

- Method Detail
  - publish
```
public CompletableFuture<String> publish(String topic,
                                         Message message)
```
    Publish a message on a specific topic.
    
    Parameters:
    
    topic - The topic name to publish on. Note that this is the short name, not the fully qualified name including project. The project to publish on is configured using the Publisher.Builder.
    
    message - The message to publish.
    
    Returns:
    
    A future that is fulfilled with the resulting Google Pub/Sub message ID when the message has been successfully published.
  - close
```
public void close()
```
    Close this Publisher. This will also close the underlying Pubsub client.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - closeFuture
```
public CompletableFuture<Void> closeFuture()
```
    Get a future that is completed when this Publisher is closed.
  - outstandingRequests
```
public int outstandingRequests()
```
    Get the current number of outstanding (batch) requests to Google Pub/Sub.
  - scheduledQueueSize
```
public int scheduledQueueSize()
```
    Get the total number of scheduled requests.
  - pendingTopics
```
public int pendingTopics()
```
    Get the current number of topics that are pending batch sending to Google Pub/Sub.
  - project
```
public String project()
```
    Get the Google Cloud project this Publisher is publishing to.
  - concurrency
```
public int concurrency()
```
    Get the concurrent Google Pub/Sub request limit.
  - topicQueueSize
```
public int topicQueueSize(String topic)
```
    Get the current queue size for the given topic name. Returns 0 if the topic does not exist.
    
    Parameters:
    
    topic - the topic name
  - queueSize
```
public int queueSize()
```
    Get the per-topic queue size.
  - batchSize
```
public int batchSize()
```
    Get the max Google Pub/Sub request batch size.
  - builder
```
public static Publisher.Builder builder()
```
    Create a builder that can be used to build a Publisher.

Class Publisher

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

publish

close

closeFuture

outstandingRequests

scheduledQueueSize

pendingTopics

project

concurrency

topicQueueSize

queueSize

batchSize

builder