io.micronaut.gcp.pubsub.annotation

Annotation Type Subscription

@Documented
 @Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface Subscription

Represents a PubSub subscription. Methods annotated with this annotation will be invoked when a new message is received by a MessageReceiver that is bound to the annotated method.

Since:

2.0

Author:

Vinicius Carvalho

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	value The name of the subscription, it could be a simple name such as "animals" or a FQN such as projects/<project_name>/subscriptions/<subscription_name>.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	configuration Defines the name of a particular configuration used for a Subscriber.
java.lang.String	contentType Defines the Content-Type to be used for message deserialization.

Element Detail

value

public abstract java.lang.String value

The name of the subscription, it could be a simple name such as "animals" or a FQN such as projects/<project_name>/subscriptions/<subscription_name>.

Returns:

the subscription name

contentType

public abstract java.lang.String contentType

Defines the Content-Type to be used for message deserialization. There's no default, if not set and the message does not contain a Content-Type header deserialization will fail.

Returns:

contentType to use

Default:

""

configuration

public abstract java.lang.String configuration

Defines the name of a particular configuration used for a Subscriber. Configurations can be set via gcp.pubsub.subscriber.*

Returns:

configuration name to use for Subscriber

Default:

""