topic |
Topic name which your server subscription will belong to |
subscription |
Subscription name which your server will listen to |
replyTopic |
Topic name which your client subscription will belong to |
replySubscription |
Subscription name which your client will listen to |
noAck |
If false, manual acknowledgment mode enabled |
init |
If false, topics and subscriptions will not be created, only validated |
checkExistence |
If false, topics and subscriptions will not be checked, only used. This only applies when init is false |
client |
Additional client options (read more here) |
publisher |
Additional topic publisher options (read more here) |
subscriber |
Additional subscriber options (read more here) |
createSubscriptionOptions |
Options to create subscription if init is set to true and a subscription is needed to be created (read more here) |
autoResume |
Automatically resume publishing a message with ordering key if it fails (read more here) |
autoDeleteSubscriptionOnShutdown |
Automatically delete the subscription that is connected by the client on shutdown. If the deletion fails, it will close the subscription |
clientIdFilter |
Allows a client to only receive the response from its own request |
appendClientIdtoSubscription |
Append client id to the name of the subscription on init |
#### Client
Client can be instantiated by importing `GCPubSubClientModule` to the root module. The clients can be registered with both the `register` method or the `registerAsync` method via `useFactory`.
```typescript
@Module({
imports: [
GCPubSubClientModule.register([{
name: 'client-1'.
config: options
}]),
GCPubSubClientModule.registerAsync([{
name: 'client-2',
imports: [ConfigModule],
inject: [ConfigService],
useFactory: (configService: ConfigService) => {
return this.configService.get('GCPubSubClientOptions')
}
}])
]
})
export class AppModule {}
```
The client can then be injected with `@InjectGCPubSubClient` decorator
```typescript
@Injectable()
export class AppService {
constructor(
@InjectGCPubSubClient('client-1') private readonly client: GCPubSUbCLient,
) {}
}
```
If the token for the client is needed for tests, the package provides a utility function `getGCPubSubClientToken` to retrive the provider token of the client.
```typescript
const token = getGCPubSubClientToken('client-1');
```
#### Message
To fully utilize the features provided by Google PubSub, the message needs to be serialized and deserialized in a certain way to ensure the integrity of the data. Therefore, a helper class, `GCPubSubMessageBuilder` is available to build messages with features such as attributes, ordering key and timeouts.
##### GCPubSubMessageBuilder
