Package io.micronaut.gcp.pubsub.annotation

Annotation Type Subscription

  • @Documented
@Retention(RUNTIME)
@Target(METHOD)
@Inherited
@Executable
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 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 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

        @AliasFor(annotation=io.micronaut.messaging.annotation.MessageMapping.class,
          member="value")
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

        java.lang.String contentType
        Defines the Content-Type to be used for message deserialization. Defaults to application/json.
        Returns:
        contentType to use
        Default:
        "application/json"

      • configuration

        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:
        ""