sealed trait Descriptor extends AnyRef
Describes a service.
A descriptor is a set of call and topic descriptors that the service provides, coupled with metadata about how the service and its calls are to be served. Metadata may include versioning and migrations, SLA's, sharding hints, circuit breaker strategies etc.
- Source
- Descriptor.scala
- Alphabetic
- By Inheritance
- Descriptor
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
- 
      
      
      
        
      
    
      
        abstract 
        val
      
      
        acls: Seq[ServiceAcl]
      
      
      The ACLs associated with this service. 
- 
      
      
      
        
      
    
      
        abstract 
        val
      
      
        autoAcl: Boolean
      
      
      Whether this service should automatically have all its service calls made publicly routable by the service gateway. 
- 
      
      
      
        
      
    
      
        abstract 
        val
      
      
        calls: Seq[Call[_, _]]
      
      
      The service calls that this service provides. 
- 
      
      
      
        
      
    
      
        abstract 
        val
      
      
        circuitBreaker: CircuitBreaker
      
      
      The default circuit breaker to use for this service. 
- 
      
      
      
        
      
    
      
        abstract 
        val
      
      
        exceptionSerializer: ExceptionSerializer
      
      
      An exception serializer, used for handling exceptions on either end. 
- 
      
      
      
        
      
    
      
        abstract 
        val
      
      
        headerFilter: HeaderFilter
      
      
      The header filter to apply across all service calls on this service 
- 
      
      
      
        
      
    
      
        abstract 
        val
      
      
        locatableService: Boolean
      
      
      Whether this service should be locatable by the service locator. 
- 
      
      
      
        
      
    
      
        abstract 
        val
      
      
        name: String
      
      
      The name of this service. The name of this service. This will be used for service lookups. 
- 
      
      
      
        
      
    
      
        abstract 
        val
      
      
        topics: Seq[TopicCall[_]]
      
      
      The topics that this service publishes. 
-  abstract def withAcls(acls: ServiceAcl*): Descriptor
-  abstract def withAutoAcl(autoAcl: Boolean): Descriptor
-  abstract def withCalls(calls: Call[_, _]*): Descriptor
-  abstract def withCircuitBreaker(circuitBreaker: CircuitBreaker): Descriptor
-  abstract def withExceptionSerializer(exceptionSerializer: ExceptionSerializer): Descriptor
-  abstract def withHeaderFilter(headerFilter: HeaderFilter): Descriptor
-  abstract def withLocatableService(locatableService: Boolean): Descriptor
-  abstract def withTopics(topics: TopicCall[_]*): Descriptor
Concrete Value Members
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        !=(arg0: Any): Boolean
      
      
      - Definition Classes
- AnyRef → Any
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        ##(): Int
      
      
      - Definition Classes
- AnyRef → Any
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        +(other: String): String
      
      
      - Implicit
- This member is added by an implicit conversion from Descriptor to any2stringadd[Descriptor] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        ->[B](y: B): (Descriptor, B)
      
      
      - Implicit
- This member is added by an implicit conversion from Descriptor to ArrowAssoc[Descriptor] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        ==(arg0: Any): Boolean
      
      
      - Definition Classes
- AnyRef → Any
 
-  def addAcls(acls: ServiceAcl*): Descriptor
-  def addCalls(calls: Call[_, _]*): Descriptor
-  def addTopics(topics: TopicCall[_]*): Descriptor
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        asInstanceOf[T0]: T0
      
      
      - Definition Classes
- Any
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        clone(): AnyRef
      
      
      - Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        ensuring(cond: (Descriptor) ⇒ Boolean, msg: ⇒ Any): Descriptor
      
      
      - Implicit
- This member is added by an implicit conversion from Descriptor to Ensuring[Descriptor] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        ensuring(cond: (Descriptor) ⇒ Boolean): Descriptor
      
      
      - Implicit
- This member is added by an implicit conversion from Descriptor to Ensuring[Descriptor] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        ensuring(cond: Boolean, msg: ⇒ Any): Descriptor
      
      
      - Implicit
- This member is added by an implicit conversion from Descriptor to Ensuring[Descriptor] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        ensuring(cond: Boolean): Descriptor
      
      
      - Implicit
- This member is added by an implicit conversion from Descriptor to Ensuring[Descriptor] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        eq(arg0: AnyRef): Boolean
      
      
      - Definition Classes
- AnyRef
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        equals(arg0: Any): Boolean
      
      
      - Definition Classes
- AnyRef → Any
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        finalize(): Unit
      
      
      - Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        formatted(fmtstr: String): String
      
      
      - Implicit
- This member is added by an implicit conversion from Descriptor to StringFormat[Descriptor] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        getClass(): Class[_]
      
      
      - Definition Classes
- AnyRef → Any
- Annotations
- @native()
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        hashCode(): Int
      
      
      - Definition Classes
- AnyRef → Any
- Annotations
- @native()
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        isInstanceOf[T0]: Boolean
      
      
      - Definition Classes
- Any
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        ne(arg0: AnyRef): Boolean
      
      
      - Definition Classes
- AnyRef
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        notify(): Unit
      
      
      - Definition Classes
- AnyRef
- Annotations
- @native()
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        notifyAll(): Unit
      
      
      - Definition Classes
- AnyRef
- Annotations
- @native()
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        synchronized[T0](arg0: ⇒ T0): T0
      
      
      - Definition Classes
- AnyRef
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        toString(): String
      
      
      - Definition Classes
- AnyRef → Any
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        wait(): Unit
      
      
      - Definition Classes
- AnyRef
- Annotations
- @throws( ... )
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        wait(arg0: Long, arg1: Int): Unit
      
      
      - Definition Classes
- AnyRef
- Annotations
- @throws( ... )
 
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        wait(arg0: Long): Unit
      
      
      - Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
 
- 
      
      
      
        
      
    
      
        
        def
      
      
        →[B](y: B): (Descriptor, B)
      
      
      - Implicit
- This member is added by an implicit conversion from Descriptor to ArrowAssoc[Descriptor] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc