Class/Object

agora.exec

ExecConfig

Related Docs: object ExecConfig | package exec

Permalink

class ExecConfig extends WorkerConfig with ExecApiConfig with Serializable

Represents a worker configuration which can execute requests

Linear Supertypes
Serializable, Serializable, ExecApiConfig, WorkerConfig, ServerConfig, RichConfigOps, LowPriorityImplicits, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExecConfig
  2. Serializable
  3. Serializable
  4. ExecApiConfig
  5. WorkerConfig
  6. ServerConfig
  7. RichConfigOps
  8. LowPriorityImplicits
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ExecConfig(execConfig: Config)

    Permalink

Type Members

  1. implicit class RichArgs extends AnyRef

    Permalink
    Definition Classes
    LowPriorityImplicits
  2. implicit class RichMap extends AnyRef

    Permalink
    Definition Classes
    LowPriorityImplicits
  3. implicit class RichString extends AnyRef

    Permalink
    Definition Classes
    LowPriorityImplicits

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 actorSystemName: String

    Permalink
    Definition Classes
    ServerConfig
  5. def asDuration(key: String): Duration

    Permalink
    Definition Classes
    RichConfigOps
  6. def asFiniteDuration(key: String): FiniteDuration

    Permalink
    Definition Classes
    RichConfigOps
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def asList(path: String, separator: Option[String]): List[String]

    Permalink
    Definition Classes
    RichConfigOps
  9. implicit def asRichConfig(c: Config): RichConfig

    Permalink
    Definition Classes
    LowPriorityImplicits
  10. def chunkSize: Int

    Permalink
    Definition Classes
    ServerConfig
  11. implicit lazy val clientConfig: ClientConfig

    Permalink
    Definition Classes
    ServerConfig
  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  13. def collectAsMap: Map[String, String]

    Permalink
    Definition Classes
    RichConfigOps
  14. def collectAsStrings: List[(String, String)]

    Permalink
    Definition Classes
    RichConfigOps
  15. val config: Config

    Permalink
    Definition Classes
    ServerConfig → RichConfigOps
  16. def defaultEnv: Map[String, String]

    Permalink
  17. lazy val defaultExchangeClient: ExchangeRestClient

    Permalink
    Attributes
    protected
    Definition Classes
    WorkerConfig
  18. def defaultFrameLength: Int

    Permalink
    Definition Classes
    ExecApiConfig
  19. def defaultUIPath: String

    Permalink
    Definition Classes
    ServerConfig
  20. def describe(implicit opts: ConfigRenderOptions): String

    Permalink
    Definition Classes
    RichConfigOps
  21. def enableCache: Boolean

    Permalink
  22. def enableSupportRoutes: Boolean

    Permalink
    Definition Classes
    ServerConfig
  23. def entries: Set[Entry[String, ConfigValue]]

    Permalink
    Definition Classes
    RichConfigOps
  24. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  26. def errorLimit: Option[Int]

    Permalink
  27. def eventMonitor: SystemEventMonitor

    Permalink
  28. def eventMonitorConfig: EventMonitorConfig

    Permalink
  29. def exchangeClient: ExchangeRestClient

    Permalink
    Definition Classes
    WorkerConfig
  30. lazy val exchangeConfig: ExchangeServerConfig

    Permalink
    Definition Classes
    WorkerConfig
  31. def execSubscriptions(resolvedLocation: HostLocation): SubscriptionGroup

    Permalink
  32. def executionClient(): ExecutionClient

    Permalink

    returns

    a client directly to the worker

  33. def filterNot(path: (String) ⇒ Boolean): Config

    Permalink
    Definition Classes
    RichConfigOps
  34. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  35. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  36. def healthUpdateFrequency: FiniteDuration

    Permalink
  37. def host: String

    Permalink
    Definition Classes
    ServerConfig
  38. def hostResolver: HostResolver

    Permalink
    Definition Classes
    ServerConfig
  39. def housekeeping: HousekeepingConfig

    Permalink
  40. def includeExchangeRoutes: Boolean

    Permalink
    Definition Classes
    WorkerConfig
  41. def includeSwaggerRoutes: Boolean

    Permalink
    Definition Classes
    ServerConfig
  42. def initialRequest: Int

    Permalink
    Definition Classes
    WorkerConfig
  43. def intersect(other: Config): Config

    Permalink
    Definition Classes
    RichConfigOps
  44. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  45. def json: String

    Permalink
    Definition Classes
    RichConfigOps
  46. def landingPage: String

    Permalink
    Definition Classes
    ExecConfig → WorkerConfig
  47. def launchBrowser: Boolean

    Permalink
    Definition Classes
    ServerConfig
  48. def location: HostLocation

    Permalink
    Definition Classes
    ServerConfig
  49. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  50. def newConfig(overrides: Map[String, String]): Config

    Permalink
    Attributes
    protected
    Definition Classes
    ServerConfig
  51. def newSystem(name: String): AkkaImplicits

    Permalink
    Definition Classes
    ServerConfig
  52. def newWorkerRoutes(exchange: Exchange): DynamicWorkerRoutes

    Permalink
    Definition Classes
    WorkerConfig
  53. def nextActorSystemName(): String

    Permalink
    Definition Classes
    ServerConfig
  54. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  55. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  56. def or(other: Config): Config

    Permalink
    Definition Classes
    RichConfigOps
  57. def origins: List[URL]

    Permalink
    Definition Classes
    RichConfigOps
  58. def pathRoots: List[String]

    Permalink
    Definition Classes
    RichConfigOps
  59. def paths: List[String]

    Permalink
    Definition Classes
    RichConfigOps
  60. def port: Int

    Permalink
    Definition Classes
    ServerConfig
  61. def remoteRunner(implicit mat: Materializer = serverImplicits.materializer): RemoteRunner

    Permalink

    returns

    a client which will execute commands via the agora.api.exchange.Exchange

  62. def routes(exchangeRoutes: Option[Route]): Route

    Permalink
    Definition Classes
    WorkerConfig
  63. def runSubscription(resolvedLocation: HostLocation): WorkSubscription

    Permalink

    resolvedLocation

    the resolve host location

    returns

    a work subscription based on the resolved host

  64. def runWithRoutes[T](routes: Route, svc: T): Future[RunningService[ServerConfig, T]]

    Permalink
    Definition Classes
    ServerConfig
  65. lazy val serverImplicits: AkkaImplicits

    Permalink
    Definition Classes
    ServerConfig
  66. def show(options: ConfigRenderOptions): Option[String]

    Permalink
    Definition Classes
    RichConfigOps
  67. def start(): Future[RunningService[ExecConfig, ExecutionRoutes]]

    Permalink

    Convenience method for starting an exec service.

    Convenience method for starting an exec service. Though this may seem oddly placed on a configuration, a service and its configuration are tightly coupled, so whether you do :

    Service(config)

    or

    config.newService

    either should be arbitrary. And by doing it this way, hopefully the readability will be better from the point of

    userArgs => config => started/running service
    returns

    a Future of a RunningService

  68. def startWorker(): Future[RunningWorker]

    Permalink
    Definition Classes
    WorkerConfig
  69. def subscription: WorkSubscription

    Permalink
    Definition Classes
    WorkerConfig
  70. lazy val subscriptionConfig: SubscriptionConfig

    Permalink
    Definition Classes
    WorkerConfig
  71. def summary(pathFilter: (String) ⇒ Boolean): List[StringEntry]

    Permalink
    Definition Classes
    RichConfigOps
  72. def swaggerApiClasses: Set[Class[_]]

    Permalink
    Attributes
    protected
    Definition Classes
    ExecConfig → WorkerConfig
  73. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    ExecConfig → ServerConfig → AnyRef → Any
  75. def unique: Config

    Permalink
    Definition Classes
    RichConfigOps
  76. def uniquePaths: List[String]

    Permalink
    Definition Classes
    RichConfigOps
  77. def unmarshalTimeout: FiniteDuration

    Permalink
    Definition Classes
    WorkerConfig
  78. implicit def uploadTimeout: FiniteDuration

    Permalink
    Definition Classes
    ExecApiConfig
  79. lazy val uploads: PathConfig

    Permalink
  80. def uploadsDir: Path

    Permalink
  81. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  84. def waitOnUserInput: Boolean

    Permalink
    Definition Classes
    ServerConfig
  85. def withFallback(fallback: Config): ExecConfig

    Permalink
    Definition Classes
    ExecConfig → WorkerConfig → ServerConfig
  86. def withOverrides(overrides: Config): ExecConfig

    Permalink
    Definition Classes
    ExecConfig → WorkerConfig → ServerConfig
  87. def withPaths(paths: List[String]): Config

    Permalink
    Definition Classes
    RichConfigOps
  88. def withPaths(first: String, theRest: String*): Config

    Permalink
    Definition Classes
    RichConfigOps
  89. def withUserArgs(args: Array[String], unrecognizedArg: (String) ⇒ Config): Config

    Permalink
    Definition Classes
    RichConfigOps
  90. def without(paths: TraversableOnce[String]): Config

    Permalink
    Definition Classes
    RichConfigOps
  91. def without(firstPath: String, theRest: String*): Config

    Permalink
    Definition Classes
    RichConfigOps
  92. def without(other: Config): Config

    Permalink
    Definition Classes
    RichConfigOps
  93. def withoutSystem: Config

    Permalink
    Definition Classes
    RichConfigOps
  94. def workspaceClient: WorkspaceClient

    Permalink

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Serializable

Inherited from ExecApiConfig

Inherited from WorkerConfig

Inherited from ServerConfig

Inherited from RichConfigOps

Inherited from LowPriorityImplicits

Inherited from AnyRef

Inherited from Any

Ungrouped