Object/Class

agora.rest.worker

SubscriptionGroup

Related Docs: class SubscriptionGroup | package worker

Permalink

object SubscriptionGroup extends Serializable

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SubscriptionGroup
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def apply(config: Config, groupsName: String): List[ConfigValue]

    Permalink

    Represents a list containing work subscriptions which should share the same subscription reference

    Represents a list containing work subscriptions which should share the same subscription reference

    Consider a groupList representing 'mySubscriptionGroups' below:

    mySubscriptionGroups : [
    
       # group one
       [${lightWorkItem1}, ${lightWorkItem2}],
    
       # group two
       [${singleHeavyItem}]
    
    ]

    where 'lightWorkItem1', 'lightWorkItem2' and 'singleHeavyItem' are assumed to be subscriptions declared elsewhere in the configuration, such as :

    # take the base subscription settings
    lightWorkItem1 = ${subscription}
    lightWorkItem1 {
      details: {
        runUser: ${USER}
        path: "rest/worker/light1"
        name: "light work item"
      }
      jobMatcher: "match-all"
      submissionMatcher: "match-all"
      subscriptionReferences : []
    }

    The intention is for each group to share a subscription reference, so 'lightWorkItem1' and 'lightWorkItem2' will agora.api.exchange.Exchange.take from the same subscription ID.

    'singleHeavyItem' sits on its own, and so doesn't use a subscription reference unless it has declared one itself

    The group's subscription reference is simply concatenated with any already declared subscriptionReferences, so if a member of a group already contains subscription references, it will also contain the group's subscription reference.

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  17. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped