Trait/Object

com.lightbend.lagom.scaladsl.api

Descriptor

Related Docs: object Descriptor | package api

Permalink

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
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Descriptor
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val acls: Seq[ServiceAcl]

    Permalink

    The ACLs associated with this service.

  2. abstract val autoAcl: Boolean

    Permalink

    Whether this service should automatically have all its service calls made publicly routable by the service gateway.

  3. abstract val calls: Seq[Call[_, _]]

    Permalink

    The service calls that this service provides.

  4. abstract val circuitBreaker: CircuitBreaker

    Permalink

    The default circuit breaker to use for this service.

  5. abstract val exceptionSerializer: ExceptionSerializer

    Permalink

    An exception serializer, used for handling exceptions on either end.

  6. abstract val headerFilter: HeaderFilter

    Permalink

    The header filter to apply across all service calls on this service

  7. abstract val locatableService: Boolean

    Permalink

    Whether this service should be locatable by the service locator.

  8. abstract val name: String

    Permalink

    The name of this service.

    The name of this service.

    This will be used for service lookups.

  9. abstract val topics: Seq[TopicCall[_]]

    Permalink

    The topics that this service publishes.

  10. abstract def withAcls(acls: ServiceAcl*): Descriptor

    Permalink
  11. abstract def withAutoAcl(autoAcl: Boolean): Descriptor

    Permalink
  12. abstract def withCalls(calls: Call[_, _]*): Descriptor

    Permalink
  13. abstract def withCircuitBreaker(circuitBreaker: CircuitBreaker): Descriptor

    Permalink
  14. abstract def withExceptionSerializer(exceptionSerializer: ExceptionSerializer): Descriptor

    Permalink
  15. abstract def withHeaderFilter(headerFilter: HeaderFilter): Descriptor

    Permalink
  16. abstract def withLocatableService(locatableService: Boolean): Descriptor

    Permalink
  17. abstract def withTopics(topics: TopicCall[_]*): Descriptor

    Permalink

Concrete Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Descriptor to any2stringadd[Descriptor] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Descriptor, B)

    Permalink
    Implicit information
    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()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def addAcls(acls: ServiceAcl*): Descriptor

    Permalink
  7. def addCalls(calls: Call[_, _]*): Descriptor

    Permalink
  8. def addTopics(topics: TopicCall[_]*): Descriptor

    Permalink
  9. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def ensuring(cond: (Descriptor) ⇒ Boolean, msg: ⇒ Any): Descriptor

    Permalink
    Implicit information
    This member is added by an implicit conversion from Descriptor to Ensuring[Descriptor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Descriptor) ⇒ Boolean): Descriptor

    Permalink
    Implicit information
    This member is added by an implicit conversion from Descriptor to Ensuring[Descriptor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): Descriptor

    Permalink
    Implicit information
    This member is added by an implicit conversion from Descriptor to Ensuring[Descriptor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Descriptor

    Permalink
    Implicit information
    This member is added by an implicit conversion from Descriptor to Ensuring[Descriptor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    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()
  19. final def getClass(): Class[_]

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. def [B](y: B): (Descriptor, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Descriptor to ArrowAssoc[Descriptor] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Descriptor to any2stringadd[Descriptor]

Inherited by implicit conversion StringFormat from Descriptor to StringFormat[Descriptor]

Inherited by implicit conversion Ensuring from Descriptor to Ensuring[Descriptor]

Inherited by implicit conversion ArrowAssoc from Descriptor to ArrowAssoc[Descriptor]

Ungrouped